Update a balance profile
patch
/crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}
Request
Path Parameters
-
BalanceProfileNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BalanceProfileName: string
Title:
Name
Maximum Length:120
The name 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.
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
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
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
Nested Schema : subscriptionBalanceProfiles-groupCriteria-item-patch-request
Type:
Show Source
object
-
BalanceCriteriaDescription: string
Title:
Description
Maximum Length:300
The description of 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. -
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.
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
Nested Schema : subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-patch-request
Type:
Show Source
object
-
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. -
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.
Nested Schema : subscriptionBalanceProfiles-profileBalanceCodes-item-patch-request
Type:
Show Source
object
-
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. -
ProfileBalanceCodeNumber: string
Maximum Length:
120
The alternate identifier of the profile balance code.
Nested Schema : schema
Type:
Show Source
object
-
AllowanceGrantFlag: boolean
Title:
Enable allowance
Maximum Length:1
Default Value:false
Indicates whether the allowance grant is enabled for a balance register profile charge. -
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.
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.
Root Schema : subscriptionBalanceProfiles-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
Nested Schema : subscriptionBalanceProfiles-groupCriteria-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionBalanceProfiles-groupCriteria-subscriptionBalancePredicates-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceProfiles-profileBalanceCodes-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceProfiles-profileCharges-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- activate
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles/{BalanceProfileNumber}/action/activateParameters:
- BalanceProfileNumber:
$request.path.BalanceProfileNumber
The method is used to activate a balance profile. - BalanceProfileNumber:
- deActivate
-
Parameters:
- BalanceProfileNumber:
$request.path.BalanceProfileNumber
The method is used to deactivate a balance profile. - BalanceProfileNumber:
- 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. - BalanceProfileNumber:
- 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. - BalanceProfileNumber:
- profileCharges
-
Parameters:
- BalanceProfileNumber:
$request.path.BalanceProfileNumber
The subscription balance profile charges resource is used to view a balance profile charges. - BalanceProfileNumber: