Jump to

• Request
• Response

Get all balance profiles

get

/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • BalProfileAltKey Finds the subscription balance profile with the specified alternative key.
    Finder Variables
    • BalanceProfileNumber; string; The balance profile number used to find balance profile alternative key.
  • BalanceProfilesFinder Finds all the active subscription balance profiles.
    Finder Variables
  • PrimaryKey Finds the subscription balance profile with the specified primary key.
    Finder Variables
    • BalanceProfileId; integer; The unique identifier of the subscription balance profile.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AllowanceEffectivityType; string; Indicates whether the period effectivity is based on balance register or subscription product.
  • AmendNewPartialPeriodOption; string; The default balance management option for first partial period of draft line during amendment of product.
  • AmendTerminatedPartialPeriodOption; string; The default balance management option for last partial period of terminated line during amendment of product.
  • BalanceProfileId; integer; The unique identifier of the subscription balance profile.
  • BalanceProfileName; string; The name of the subscription balance profile.
  • BalanceProfileNumber; string; The unique number of the subscription balance profile.
  • BalanceProfileStatus; string; The status of the subscription balance profile.
  • BillOnDay; integer; The bill on day of the subscription balance profile.
  • BillPeriodAlignDate; string; The bill alignment date of the subscription balance profile.
  • BillingDate; string; The billing date of the subscription balance profile.
  • BillingDateCode; string; The billing date code of the subscription balance profile.
  • BillingFrequency; string; The billing frequency of the subscription balance profile.
  • BillingFrequencyUnitOfMeasure; string; The billing frequency unit of measure of the subscription balance profile.
  • BillingOffsetDays; integer; The name of the subscription balance profile.
  • CreatedBy; string; The user who created the subscription balance profile.
  • CreationDate; string; The date when the subscription balance profile was created.
  • EstimateDateCode; string; The estimate date of the subscription balance profile.
  • EstimateOffsetDays; integer; The offset of estimate date of the subscription balance profile.
  • EventType; string; The type of an event.
  • EventTypeId; integer; The unique identifier of the event type.
  • FirstPartialPeriodOption; string; The default balance management option for first partial period of subscription product while adding the product.
  • FixedDaysInMonth; number; The number of days in month which is considered for average calculation.
  • InterfaceOffsetDays; integer; The interface offset days of the subscription balance profile.
  • InvoicingRuleId; integer; The invoice rule identifier of the subscription balance profile.
  • InvoicingRuleName; string; The invoice rule name of the subscription balance profile.
  • LastPartialPeriodOption; string; The default balance management option for last partial period of subscription product while adding the product.
  • LastUpdateDate; string; The date when the subscription balance profile was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the subscription balance profile.
  • LastUpdatedBy; string; The user who has last updated the subscription balance profile.
  • ManualTrueupFlag; boolean; Indicates whether the manual true up is enabled.
  • ObjectVersionNumber; integer; The object version number updated after every update of a subscription balance profile.
  • PartialPeriodMonthType; string; Indicates whether the month period is fixed or actual.
  • PeriodAlignDateType; string; The period align date type of the subscription balance profile.
  • RegisterUpdateFlag; boolean; Indicates whether the register is enabled for update.
  • SummarizedOffsetDays; number; The offset summarized rating days of the subscription balance profile.
  • SummarizedRatingDateCode; string; The summarized rating date of the subscription balance profile.
  • TerminatedPartialPeriodOption; string; The default balance management option for last partial period of subscription product while closing the product.
  • TrueupOffsetCode; string; The trued up date of the subscription balance profile.
  • TrueupOffsetDays; number; The offset trued up days of the subscription balance profile.
  • TrueupOverrideFlag; boolean; Indicates whether the true up override is enabled.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptionBalanceProfiles

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object subscriptionBalanceProfiles-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceProfiles-item-response

Type: object

Show Source

• AllowanceEffectivityType: string
  Title: Allowance Effectivity Type

  Maximum Length: 30

  Default Value: ORA_OSS_BAL_REGISTER_PERIOD

  Indicates whether the period effectivity is based on balance register or subscription product.
• AmendNewPartialPeriodOption: string
  Title: New Line First Period

  Maximum Length: 30

  The default balance management option for first partial period of draft line during amendment of product.
• AmendTerminatedPartialPeriodOption: string
  Title: Terminated Line Last Period

  Maximum Length: 30

  The default balance management option for last partial period of terminated line during amendment of product.
• BalanceProfileId: integer (int64)
  The unique identifier of the subscription balance profile.
• BalanceProfileName: string
  Title: Name

  Maximum Length: 120

  The name of the subscription balance profile.
• BalanceProfileNumber: string
  Title: Number

  Maximum Length: 120

  The unique number of the subscription balance profile.
• BalanceProfileStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription balance profile.
• BillingDate: string
  Title: Billing Date

  Maximum Length: 80

  The billing date of the subscription balance profile.
• BillingDateCode: string
  Title: Billing Date

  Maximum Length: 30

  The billing date code of the subscription balance profile.
• BillingFrequency: string
  Title: Billing Frequency

  Maximum Length: 30

  The billing frequency of the subscription balance profile.
• BillingFrequencyUnitOfMeasure: string
  Title: Billing Frequency

  Maximum Length: 25

  The billing frequency unit of measure of the subscription balance profile.
• BillingOffsetDays: integer (int32)
  Title: Offset

  The name of the subscription balance profile.
• BillOnDay: integer (int32)
  Title: Day

  The bill on day of the subscription balance profile.
• BillPeriodAlignDate: string (date)
  Title: Alignment Date

  The bill alignment date of the subscription balance profile.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance profile.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance profile was created.
• EstimateDateCode: string
  Title: Estimate Date

  Maximum Length: 30

  The estimate date of the subscription balance profile.
• EstimateOffsetDays: integer
  Title: Offset

  The offset of estimate date of the subscription balance profile.
• EventType: string
  Title: True-Up Event Type

  Maximum Length: 30

  The type of an event.
• EventTypeId: integer (int64)
  The unique identifier of the event type.
• FirstPartialPeriodOption: string
  Title: First Period

  Maximum Length: 30

  The default balance management option for first partial period of subscription product while adding the product.
• FixedDaysInMonth: number
  Title: Number of Days in Month

  Default Value: 31

  The number of days in month which is considered for average calculation.
• groupCriteria: array Subscription Balance Condition Criteria
  Title: Subscription Balance Condition Criteria

  The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.
• InterfaceOffsetDays: integer (int32)
  Title: Billing Interface Offset Days

  The interface offset days of the subscription balance profile.
• InvoicingRuleId: integer (int64)
  Title: Invoicing Rule

  The invoice rule identifier of the subscription balance profile.
• InvoicingRuleName: string
  Title: Invoicing Rule

  Maximum Length: 30

  The invoice rule name of the subscription balance profile.
• LastPartialPeriodOption: string
  Title: Last Period

  Maximum Length: 30

  The default balance management option for last partial period of subscription product while adding the product.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription balance profile was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance profile.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription balance profile.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualTrueupFlag: boolean
  Title: Allow manual true-up

  Maximum Length: 1

  Default Value: false

  Indicates whether the manual true up is enabled.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance profile.
• PartialPeriodMonthType: string
  Title: Partial Month Type

  Maximum Length: 30

  Default Value: ORA_FIXED

  Indicates whether the month period is fixed or actual.
• PeriodAlignDateType: string
  Title: Period Alignment Date Type

  Maximum Length: 30

  Default Value: ORA_OSS_BAL_REG_AND_BILL_LINES

  The period align date type of the subscription balance profile.
• profileBalanceCodes: array Subscription Profile Balance Codes
  Title: Subscription Profile Balance Codes

  The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.
• profileCharges: array Subscription Balance Profile Charges
  Title: Subscription Balance Profile Charges

  The subscription balance profile charges resource is used to view a balance profile charges.
• RegisterUpdateFlag: boolean
  Title: Allow register update

  Maximum Length: 1

  Default Value: false

  Indicates whether the register is enabled for update.
• SummarizedOffsetDays: number
  Title: Offset

  The offset summarized rating days of the subscription balance profile.
• SummarizedRatingDateCode: string
  Title: Summarized Date

  Maximum Length: 30

  The summarized rating date of the subscription balance profile.
• TerminatedPartialPeriodOption: string
  Title: Terminated Line Last Period

  Maximum Length: 30

  The default balance management option for last partial period of subscription product while closing the product.
• TrueupOffsetCode: string
  Title: True-Up Date

  Maximum Length: 30

  The trued up date of the subscription balance profile.
• TrueupOffsetDays: number
  Title: Offset

  The offset trued up days of the subscription balance profile.
• TrueupOverrideFlag: boolean
  Title: Allow true-up override

  Maximum Length: 1

  Default Value: false

  Indicates whether the true up override is enabled.

{
    "type":"object",
    "properties":{
        "AllowanceEffectivityType":{
            "title":"Allowance Effectivity Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the period effectivity is based on balance register or subscription product.",
            "nullable":true,
            "default":"ORA_OSS_BAL_REGISTER_PERIOD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AmendNewPartialPeriodOption":{
            "title":"New Line First Period",
            "maxLength":30,
            "type":"string",
            "description":"The default balance management option for first partial period of draft line during amendment of product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AmendTerminatedPartialPeriodOption":{
            "title":"Terminated Line Last Period",
            "maxLength":30,
            "type":"string",
            "description":"The default balance management option for last partial period of terminated line during amendment of product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the subscription balance profile.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceProfileNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance profile.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceProfileStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance profile.",
            "nullable":true,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillOnDay":{
            "title":"Day",
            "type":"integer",
            "description":"The bill on day of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "BillPeriodAlignDate":{
            "title":"Alignment Date",
            "type":"string",
            "description":"The bill alignment date of the subscription balance profile.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BillingDate":{
            "title":"Billing Date",
            "maxLength":80,
            "type":"string",
            "description":"The billing date of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":30,
            "type":"string",
            "description":"The billing date code of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingFrequencyUnitOfMeasure":{
            "title":"Billing Frequency",
            "maxLength":25,
            "type":"string",
            "description":"The billing frequency unit of measure of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillingOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The name of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimateDateCode":{
            "title":"Estimate Date",
            "maxLength":30,
            "type":"string",
            "description":"The estimate date of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EstimateOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The offset of estimate date of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "EventType":{
            "title":"True-Up Event Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of an event.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EventTypeId":{
            "type":"integer",
            "description":"The unique identifier of the event type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstPartialPeriodOption":{
            "title":"First Period",
            "maxLength":30,
            "type":"string",
            "description":"The default balance management option for first partial period of subscription product while adding the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FixedDaysInMonth":{
            "title":"Number of Days in Month",
            "type":"number",
            "description":"The number of days in month which is considered for average calculation.",
            "nullable":true,
            "default":31,
            "x-hints":{
                "dependencies":[
                    "PartialPeriodMonthType"
                ]
            },
            "x-queryable":true
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The interface offset days of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule",
            "type":"integer",
            "description":"The invoice rule identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoicingRuleName":{
            "title":"Invoicing Rule",
            "maxLength":30,
            "type":"string",
            "description":"The invoice rule name of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastPartialPeriodOption":{
            "title":"Last Period",
            "maxLength":30,
            "type":"string",
            "description":"The default balance management option for last partial period of subscription product while adding the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance profile was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualTrueupFlag":{
            "title":"Allow manual true-up",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the manual true up is enabled.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance profile.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PartialPeriodMonthType":{
            "title":"Partial Month Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the month period is fixed or actual.",
            "nullable":true,
            "default":"ORA_FIXED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodAlignDateType":{
            "title":"Period Alignment Date Type",
            "maxLength":30,
            "type":"string",
            "description":"The period align date type of the subscription balance profile.",
            "nullable":true,
            "default":"ORA_OSS_BAL_REG_AND_BILL_LINES",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RegisterUpdateFlag":{
            "title":"Allow register update",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the register is enabled for update.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SummarizedOffsetDays":{
            "title":"Offset",
            "type":"number",
            "description":"The offset summarized rating days of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "SummarizedRatingDateCode":{
            "title":"Summarized Date",
            "maxLength":30,
            "type":"string",
            "description":"The summarized rating date of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerminatedPartialPeriodOption":{
            "title":"Terminated Line Last Period",
            "maxLength":30,
            "type":"string",
            "description":"The default balance management option for last partial period of subscription product while closing the product.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TrueupOffsetCode":{
            "title":"True-Up Date",
            "maxLength":30,
            "type":"string",
            "description":"The trued up date of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupOffsetDays":{
            "title":"Offset",
            "type":"number",
            "description":"The offset trued up days of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupOverrideFlag":{
            "title":"Allow true-up override",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the true up override is enabled.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "groupCriteria":{
            "title":"Subscription Balance Condition Criteria",
            "type":"array",
            "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "profileBalanceCodes":{
            "title":"Subscription Profile Balance Codes",
            "type":"array",
            "description":"The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileBalanceCodes-item-response"
            }
        },
        "profileCharges":{
            "title":"Subscription Balance Profile Charges",
            "type":"array",
            "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileCharges-item-response"
            }
        }
    }
}

Nested Schema : Subscription Balance Condition Criteria

Type: array

Title: Subscription Balance Condition Criteria

The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.

Show Source

• Array of: object subscriptionBalanceProfiles-groupCriteria-item-response

{
    "title":"Subscription Balance Condition Criteria",
    "type":"array",
    "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Subscription Profile Balance Codes

Type: array

Title: Subscription Profile Balance Codes

The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.

Show Source

• Array of: object subscriptionBalanceProfiles-profileBalanceCodes-item-response

{
    "title":"Subscription Profile Balance Codes",
    "type":"array",
    "description":"The subscription balance profile balance codes resource is used to view, create, update, and delete a balance profile balance code.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileBalanceCodes-item-response"
    }
}

Nested Schema : Subscription Balance Profile Charges

Type: array

Title: Subscription Balance Profile Charges

The subscription balance profile charges resource is used to view a balance profile charges.

Show Source

• Array of: object subscriptionBalanceProfiles-profileCharges-item-response

{
    "title":"Subscription Balance Profile Charges",
    "type":"array",
    "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-profileCharges-item-response"
    }
}

Nested Schema : subscriptionBalanceProfiles-groupCriteria-item-response

Type: object

Show Source

• BalanceCriteriaDescription: string
  Title: Description

  Maximum Length: 300

  The description of subscription balance criterion.
• BalanceCriteriaId: integer (int64)
  The unique identifier of the subscription balance criterion.
• BalanceCriteriaNumber: string
  Title: Criteria

  Maximum Length: 120

  The unique number of the subscription balance criterion.
• BalanceCriteriaStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription balance criterion.
• BalanceCriteriaUsage: string
  Title: Usage

  Maximum Length: 30

  The usage condition of subscription balance criterion.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance criterion.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance criterion was created.
• CriteriaPrecedence: integer
  Title: Sequence

  The order in which the criteria will be evaluated.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription balance criterion was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance criterion.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription balance criterion.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance criterion.
• subscriptionBalancePredicates: array Subscription Balance Condition Predicates
  Title: Subscription Balance Condition Predicates

  The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.

{
    "type":"object",
    "properties":{
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of subscription balance criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance criterion.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The usage condition of subscription balance criterion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaPrecedence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order in which the criteria will be evaluated.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance criterion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Condition Predicates",
            "type":"array",
            "description":"The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Subscription Balance Condition Predicates

Type: array

Title: Subscription Balance Condition Predicates

The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.

Show Source

• Array of: object subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response

{
    "title":"Subscription Balance Condition Predicates",
    "type":"array",
    "description":"The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response

Type: object

Show Source

• BalanceAttributeId: integer (int64)
  The unique identifier of the subscription balance attribute.
• BalanceAttributeName: string
  Title: Attribute Name

  Maximum Length: 240

  The name of the subscription balance attribute.
• BalanceCriteriaId: integer (int64)
  The balance criteria Id of subscription balance predicate.
• BalanceObjectId: integer (int64)
  The balance object identifier of subscription balance predicate.
• BalanceObjectName: string
  Title: Object Name

  Maximum Length: 120

  The balance object name of subscription balance predicate.
• BalancePredicateCharacterValue: string
  Title: Value

  Maximum Length: 600

  The balance predicate character value of subscription balance predicate.
• BalancePredicateDateValue: string (date)
  Title: Value

  The balance predicate date value of subscription balance predicate.
• BalancePredicateDecimalValue: number
  Title: Value

  The balance predicate decimal value of subscription balance predicate.
• BalancePredicateId: integer (int64)
  The unique identifier of the subscription balance predicate.
• BalancePredicateNumber: string
  Title: Number

  Maximum Length: 120

  The unique number of the subscription balance predicate.
• BalancePredicateNumberValue: integer
  Title: Value

  The number value of the subscription balance predicate.
• BalancePredicateOperator: string
  Title: Operator

  Maximum Length: 30

  The operator value of the subscription balance predicate.
• BalancePredicateSequence: integer
  Title: Sequence

  The balance predicate sequence of the subscription balance predicate.
• BalancePredicateSortBy: string
  Title: Sort Order

  Maximum Length: 30

  The sort by criterion of the subscription balance predicate.
• BalancePredicateTimeValue: string (date-time)
  Title: Value

  The time value of the subscription balance predicate.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance predicate.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance predicate was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription balance predicate was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance predicate.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription balance predicate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the subscription balance predicate.
• SourceType: string
  Title: Source Type

  Maximum Length: 30

  Default Value: ORA_OSS_USER

  The source type of the subscription balance predicate.

{
    "type":"object",
    "properties":{
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the subscription balance attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria Id of subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance object name of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":600,
            "type":"string",
            "description":"The balance predicate character value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePredicateNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance predicate.",
            "nullable":false,
            "x-queryable":true
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The operator value of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":30,
            "type":"string",
            "description":"The sort by criterion of the subscription balance predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance predicate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance predicate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription balance predicate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription balance predicate.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The source type of the subscription balance predicate.",
            "nullable":true,
            "default":"ORA_OSS_USER",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceProfiles-profileBalanceCodes-item-response

Type: object

Show Source

• AllowanceGrantCodeFlag: boolean
  Title: Enable allowance

  Maximum Length: 1

  Default Value: false

  The balance code should be used for allowance grant of the subscription profile balance code.
• BalanceCode: string
  Title: Code

  Maximum Length: 30

  The balance code of the subscription balance profile balance code.
• BalanceCodeDescription: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  The balance code description of the subscription profile balance code.
• BalanceCodeId: integer (int64)
  Title: Balance Code

  The unique identifier of the balance code.
• BalancePrecedence: number
  Title: Precedence

  The precedence for balance code for given subscription balance profile.
• BalanceProfileChargeId: integer (int64)
  The unique identifier of the balance profile charge.
• BalanceProfileId: integer (int64)
  The unique identifier of the balance profile.
• CommitmentCodeFlag: boolean
  Title: Enable commitment

  Maximum Length: 1

  Default Value: false

  Indicates whether the balance code is for enable commitments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription profile balance code.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription profile balance code was created.
• EstimateCodeFlag: boolean
  Title: Enable estimate

  Maximum Length: 1

  Default Value: false

  Indicates whether the balance code is for enable estimates.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription profile balance code was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription profile balance code.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription profile balance code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the subscription profile balance code.
• ProfileBalanceCodeId: integer (int64)
  The unique identifier of the balance profile code.
• ProfileBalanceCodeNumber: string
  Maximum Length: 120

  The alternate identifier of the profile balance code.
• VolumePricingFlag: boolean
  Title: Enable volume pricing

  Maximum Length: 1

  Default Value: false

  Indicates whether the profile balance code is enable for volume pricing.

{
    "type":"object",
    "properties":{
        "AllowanceGrantCodeFlag":{
            "title":"Enable allowance",
            "maxLength":1,
            "type":"boolean",
            "description":"The balance code should be used for allowance grant of the subscription profile balance code.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The balance code of the subscription balance profile balance code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeDescription":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The balance code description of the subscription profile balance code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "BalancePrecedence":{
            "title":"Precedence",
            "type":"number",
            "description":"The precedence for balance code for given subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CommitmentCodeFlag":{
            "title":"Enable commitment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable commitments.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription profile balance code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription profile balance code was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimateCodeFlag":{
            "title":"Enable estimate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable estimates.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription profile balance code was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription profile balance code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription profile balance code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription profile balance code.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProfileBalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfileBalanceCodeNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the profile balance code.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumePricingFlag":{
            "title":"Enable volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the profile balance code is enable for volume pricing.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceProfiles-profileCharges-item-response

Type: object

Show Source

• AllowanceGrantFlag: boolean
  Title: Enable allowance

  Maximum Length: 1

  Default Value: false

  Indicates whether the allowance grant is enabled for a balance register profile charge.
• BalanceProfileChargeId: integer (int64)
  The balance profile charge identifier of the subscription balance profile charges.
• BalanceProfileChargeNumber: string
  Title: Profile Charge Number

  Maximum Length: 120

  The balance profile charge number of the subscription balance profile charges.
• BalanceProfileId: integer (int64)
  The balance profile identifier of the subscription balance profile charges.
• BillingFrequency: string
  Title: Billing Frequency

  Maximum Length: 30

  The billing frequency of the subscription balance profile charge.
• BillingFrequencyUnitOfMeasure: string
  Title: Billing Frequency

  Maximum Length: 25

  The billing frequency unit of measure of the subscription balance profile charge.
• ChargeDefinitionCode: string
  Title: Charge Definition

  Maximum Length: 30

  The charge definition code of the subscription balance profile charges.
• ChargeDefinitionId: integer (int64)
  Title: Charge Name

  The balance charge definition identifier of the subscription balance profile charges.
• ChargePeriod: string
  Title: Periodicity

  Maximum Length: 30

  The charge period of the subscription balance profile charges.
• ChargePeriodUnitOfMeasure: string
  Title: Periodicity

  Maximum Length: 25

  The charge period unit of measure of the subscription balance profile charges.
• CommitmentFlag: boolean
  Title: Enable commitment

  Maximum Length: 1

  Default Value: false

  Indicates whether the commitment is enabled for a balance register profile charge.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance profile charges.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance profile charge was created.
• EstimateFlag: boolean
  Title: Enable estimate

  Maximum Length: 1

  Default Value: false

  Indicates whether the estimate is enabled for a balance register profile charge.
• InvoicingRule: string
  Title: Invoicing Rule

  Maximum Length: 30

  The invoicing rule of the subscription balance profile charge.
• InvoicingRuleId: integer (int64)
  The invoicing rule identifier of the subscription balance profile charge.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription profile charge was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance criterion.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription profile charge.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription profile charge.
• RelatedChargeDefinitionCode: string
  Title: Related Charge

  Maximum Length: 30

  The charge definition code of the related profile charge.
• RelatedChargeDefinitionId: integer (int64)
  Title: Related Charge

  The charge definition identifier of the related profile charge.
• RelatedProfileChargeId: integer (int64)
  The balance profile charge identifier of the related charge identifier.
• UsageCaptureFlag: boolean
  Title: Enable usage capture

  Maximum Length: 1

  Default Value: false

  Indicates whether the usage capture is enabled for a balance register profile charge.
• VolumePricingFlag: boolean
  Title: Enable volume pricing

  Maximum Length: 1

  Default Value: false

  Indicates whether the profile charge is enabled for volume pricing.

{
    "type":"object",
    "properties":{
        "AllowanceGrantFlag":{
            "title":"Enable allowance",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the allowance grant is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceProfileChargeNumber":{
            "title":"Profile Charge Number",
            "maxLength":120,
            "type":"string",
            "description":"The balance profile charge number of the subscription balance profile charges.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The billing frequency of the subscription balance profile charge.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingFrequencyUnitOfMeasure":{
            "title":"Billing Frequency",
            "maxLength":25,
            "type":"string",
            "description":"The billing frequency unit of measure of the subscription balance profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "title":"Charge Definition",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Name",
            "type":"integer",
            "description":"The balance charge definition identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":30,
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "ChargePeriodUnitOfMeasure":{
            "title":"Periodicity",
            "maxLength":25,
            "type":"string",
            "description":"The charge period unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CommitmentFlag":{
            "title":"Enable commitment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the commitment is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance profile charges.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimateFlag":{
            "title":"Enable estimate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the estimate is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "InvoicingRule":{
            "title":"Invoicing Rule",
            "maxLength":30,
            "type":"string",
            "description":"The invoicing rule of the subscription balance profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The invoicing rule identifier of the subscription balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription profile charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription profile charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription profile charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionCode":{
            "title":"Related Charge",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the related profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionId":{
            "title":"Related Charge",
            "type":"integer",
            "description":"The charge definition identifier of the related profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AllowanceGrantFlag",
                    "CommitmentFlag",
                    "EstimateFlag"
                ]
            },
            "x-queryable":true
        },
        "RelatedProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the related charge identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageCaptureFlag":{
            "title":"Enable usage capture",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the usage capture is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "VolumePricingFlag":{
            "title":"Enable volume pricing",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the profile charge is enabled for volume pricing.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top