Jump to

• Request
• Response

Create a balance profile

post

/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles

Request

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BalanceProfileId: integer (int64)
  The unique identifier of the subscription balance profile.
• BalanceProfileName(required): string
  Title: Name

  Maximum Length: 120

  The name of the subscription balance profile.
• BalanceProfileNumber(required): 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: Align Billing From

  The bill alignment date of the subscription balance profile.
• 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.
• groupCriteria: array Subscription Balance Consumption Criteria
  Title: Subscription Balance Consumption Criteria

  The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
• 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.
• 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.
• 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.
• 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.

{
    "required":[
        "BalanceProfileName",
        "BalanceProfileNumber"
    ],
    "type":"object",
    "properties":{
        "BillingOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The name of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            }
        },
        "EventType":{
            "title":"True-Up Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of an event.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EstimateOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The offset of estimate date of the subscription balance profile.",
            "nullable":true
        },
        "TrueupOffsetCode":{
            "title":"True-Up Date",
            "maxLength":"30",
            "type":"string",
            "description":"The trued up date of the subscription balance profile.",
            "nullable":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"
            }
        },
        "EventTypeId":{
            "type":"integer",
            "description":"The unique identifier of the event type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalanceProfileName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"The name of the subscription balance profile.",
            "nullable":false
        },
        "BillingDate":{
            "title":"Billing Date",
            "maxLength":"80",
            "type":"string",
            "description":"The billing date of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "groupCriteria":{
            "title":"Subscription Balance Consumption Criteria",
            "type":"array",
            "description":"The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-post-request"
            },
            "x-cardinality":"1"
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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-post-request"
            }
        },
        "BalanceProfileNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance profile.",
            "nullable":false
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule",
            "type":"integer",
            "description":"The invoice rule identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":"30",
            "type":"string",
            "description":"The billing date code of the subscription balance profile.",
            "nullable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"The billing frequency of the subscription balance profile.",
            "nullable":true
        },
        "TrueupOverrideFlag":{
            "title":"Allow true-up override",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up override is enabled.",
            "nullable":true,
            "default":false
        },
        "BillOnDay":{
            "title":"Day",
            "type":"integer",
            "description":"The bill on day of the subscription balance profile.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            }
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "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-post-request"
            }
        },
        "ManualTrueupFlag":{
            "title":"Allow manual true-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the manual true up is enabled.",
            "nullable":true,
            "default":false
        },
        "RegisterUpdateFlag":{
            "title":"Allow register update",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the register is enabled for update.",
            "nullable":true,
            "default":false
        },
        "BillPeriodAlignDate":{
            "title":"Align Billing From",
            "type":"string",
            "description":"The bill alignment date of the subscription balance profile.",
            "format":"date",
            "nullable":true
        },
        "TrueupOffsetDays":{
            "title":"Offset",
            "type":"number",
            "description":"The offset trued up days of the subscription balance profile.",
            "nullable":true
        },
        "EstimateDateCode":{
            "title":"Estimate Date",
            "maxLength":"30",
            "type":"string",
            "description":"The estimate date of the subscription balance profile.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Subscription Balance Consumption Criteria

Type: array

Title: Subscription Balance Consumption Criteria

The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Show Source

• Array of: object subscriptionBalanceProfiles-groupCriteria-item-post-request

{
    "title":"Subscription Balance Consumption Criteria",
    "type":"array",
    "description":"The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-post-request"
    },
    "x-cardinality":"1"
}

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 schema

{
    "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-post-request"
    }
}

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 schema

{
    "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-post-request"
    }
}

Nested Schema : subscriptionBalanceProfiles-groupCriteria-item-post-request

Type: object

Show Source

• BalanceCriteriaDescription: string
  Title: Description

  Maximum Length: 300

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

  Maximum Length: 120

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

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription balance consumption criterion.
• BalanceCriteriaUsage(required): string
  Title: Usage

  Maximum Length: 30

  The usage condition of subscription balance consumption criterion.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance consumption criterion.
• subscriptionBalancePredicates: array Subscription Balance Consumption Predicates
  Title: Subscription Balance Consumption Predicates

  The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

{
    "required":[
        "BalanceCriteriaNumber",
        "BalanceCriteriaUsage"
    ],
    "type":"object",
    "properties":{
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The description of subscription balance consumption criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance consumption criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"The usage condition of subscription balance consumption criterion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Consumption Predicates",
            "type":"array",
            "description":"The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-post-request"
            }
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the subscription balance consumption criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance consumption criterion.",
            "nullable":false
        }
    }
}

Nested Schema : Subscription Balance Consumption Predicates

Type: array

Title: Subscription Balance Consumption Predicates

The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Show Source

• Array of: object subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-post-request

{
    "title":"Subscription Balance Consumption Predicates",
    "type":"array",
    "description":"The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-post-request"
    }
}

Nested Schema : subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-post-request

Type: object

Show Source

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

  Maximum Length: 240

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

  Maximum Length: 120

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

  Maximum Length: 600

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

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

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

  Maximum Length: 120

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

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

  Maximum Length: 30

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

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

  Maximum Length: 30

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

  The time value of the subscription balance consumption predicate.

{
    "type":"object",
    "properties":{
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria identifier of subscription balance consumption predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":"30",
            "type":"string",
            "description":"The sort by criterion of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance consumption predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance consumption predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance object name of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance consumption predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":"30",
            "type":"string",
            "description":"The operator value of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":"600",
            "type":"string",
            "description":"The balance predicate character value of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance consumption predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance consumption predicate.",
            "nullable":false
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the subscription balance consumption attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        }
    }
}

Nested Schema : schema

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.
• 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.
• EstimateCodeFlag: boolean
  Title: Enable estimate

  Maximum Length: 1

  Default Value: false

  Indicates whether the balance code is for enable estimates.
• ProfileBalanceCodeId: integer (int64)
  The unique identifier of the balance profile code.
• ProfileBalanceCodeNumber: string
  Maximum Length: 120

  The alternate identifier of the profile balance code.

{
    "type":"object",
    "properties":{
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProfileBalanceCodeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CommitmentCodeFlag":{
            "title":"Enable commitment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable commitments.",
            "nullable":true,
            "default":false
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "EstimateCodeFlag":{
            "title":"Enable estimate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the balance code is for enable estimates.",
            "nullable":true,
            "default":false
        },
        "ProfileBalanceCodeNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The alternate identifier of the profile balance code.",
            "nullable":true
        },
        "BalancePrecedence":{
            "title":"Precedence",
            "type":"number",
            "description":"The precedence for balance code for given subscription balance profile.",
            "nullable":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"
            }
        }
    }
}

Nested Schema : schema

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
  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
  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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The invoicing rule identifier of the subscription balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillingFrequency":{
            "maxLength":"30",
            "type":"string",
            "description":"The billing frequency of the subscription balance profile charge.",
            "nullable":true
        },
        "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"
                ]
            }
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the related charge identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
                ]
            }
        },
        "BalanceProfileChargeNumber":{
            "title":"Profile Charge Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile charge number of the subscription balance profile charges.",
            "nullable":false
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
                ]
            }
        },
        "RelatedChargeDefinitionCode":{
            "title":"Related Charge",
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the related profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":"30",
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            }
        }
    }
}

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-item-response

Type: object

Show Source

• 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: Align Billing From

  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.
• groupCriteria: array Subscription Balance Consumption Criteria
  Title: Subscription Balance Consumption Criteria

  The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
• 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.
• 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.
• 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.
• 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":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "EstimateOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The offset of estimate date of the subscription balance profile.",
            "nullable":true,
            "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
        },
        "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
        },
        "EventTypeId":{
            "type":"integer",
            "description":"The unique identifier of the event type.",
            "format":"int64",
            "nullable":true,
            "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
        },
        "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
        },
        "groupCriteria":{
            "title":"Subscription Balance Consumption Criteria",
            "type":"array",
            "description":"The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceProfileNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance profile.",
            "nullable":false,
            "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
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":"30",
            "type":"string",
            "description":"The billing date code of the subscription balance profile.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance profile.",
            "nullable":false,
            "readOnly":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
        },
        "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
        },
        "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
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "BillPeriodAlignDate":{
            "title":"Align Billing From",
            "type":"string",
            "description":"The bill alignment date of the subscription balance profile.",
            "format":"date",
            "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
        },
        "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
        },
        "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
        }
    }
}

Nested Schema : Subscription Balance Consumption Criteria

Type: array

Title: Subscription Balance Consumption Criteria

The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Show Source

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

{
    "title":"Subscription Balance Consumption Criteria",
    "type":"array",
    "description":"The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.",
    "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 consumption criterion.
• BalanceCriteriaId: integer (int64)
  The unique identifier of the subscription balance consumption criterion.
• BalanceCriteriaNumber: string
  Title: Criteria

  Maximum Length: 120

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

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

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

  Maximum Length: 30

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

  Maximum Length: 64

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

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

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the subscription balance consumption 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 consumption criterion.
• subscriptionBalancePredicates: array Subscription Balance Consumption Predicates
  Title: Subscription Balance Consumption Predicates

  The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance consumption criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance consumption criterion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance consumption criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Consumption Predicates",
            "type":"array",
            "description":"The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response"
            }
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the subscription balance consumption criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance consumption criterion.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The description of subscription balance consumption criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance consumption criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"The usage condition of subscription balance consumption criterion.",
            "nullable":false,
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance consumption 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 consumption criterion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 Consumption Predicates

Type: array

Title: Subscription Balance Consumption Predicates

The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

Show Source

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

{
    "title":"Subscription Balance Consumption Predicates",
    "type":"array",
    "description":"The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.",
    "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 consumption attribute.
• BalanceAttributeName: string
  Title: Attribute Name

  Maximum Length: 240

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

  Maximum Length: 120

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

  Maximum Length: 600

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

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

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

  Maximum Length: 120

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

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

  Maximum Length: 30

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

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

  Maximum Length: 30

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

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

  Maximum Length: 64

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

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

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

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the subscription balance consumption 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 consumption predicate.

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

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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated 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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription profile balance code.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "ProfileBalanceCodeNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The alternate identifier of the profile balance code.",
            "nullable":true,
            "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
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The unique identifier of the balance profile.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalanceCodeId":{
            "title":"Balance Code",
            "type":"integer",
            "description":"The unique identifier of the balance code.",
            "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BalancePrecedence":{
            "title":"Precedence",
            "type":"number",
            "description":"The precedence for balance code for given subscription balance profile.",
            "nullable":true,
            "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
        },
        "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
        }
    }
}

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
  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
  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance profile charges.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingFrequency":{
            "maxLength":"30",
            "type":"string",
            "description":"The billing frequency of the subscription balance profile charge.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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"
    }
}

Links

activate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/action/activate

Parameters:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

The method is used to activate a balance profile.

deActivate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/action/deActivate

Parameters:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

The method is used to deactivate a balance profile.

groupCriteria

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/groupCriteria

Parameters:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.

profileBalanceCodes

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileBalanceCodes

Parameters:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

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

profileCharges

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/profileCharges

Parameters:

• BalanceProfileNumber: $request.path.BalanceProfileNumber

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

Back to Top