Jump to

• Request
• Response

Update a rate plan charge determinant

patch

/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/{RatePlanDeterminantNumber}/child/charges/{ChargeDeterminantPuid}

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• determinantRules: array Subscription Balance Condition Criteria
  Title: Subscription Balance Condition Criteria

  The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.
• ReportedQuantityAttribute: string
  Title: Reported Quantity

  Maximum Length: 60

  The reported usage quantity which has to be rated.
• ReportedUnitOfMeasureAttribute: string
  Title: Reported UOM

  Maximum Length: 60

  The reported unit of measure attribute name of the subscription event type charge.

{
    "type":"object",
    "properties":{
        "ReportedQuantityAttribute":{
            "title":"Reported Quantity",
            "maxLength":60,
            "type":"string",
            "description":"The reported usage quantity which has to be rated.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ReportedUnitOfMeasureAttribute":{
            "title":"Reported UOM",
            "maxLength":60,
            "type":"string",
            "description":"The reported unit of measure attribute name of the subscription event type charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "determinantRules":{
            "title":"Subscription Balance Condition Criteria",
            "type":"array",
            "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageRatingDeterminants-charges-determinantRules-item-patch-request"
            }
        }
    }
}

Nested Schema : Subscription Balance Condition Criteria

Type: array

Title: Subscription Balance Condition Criteria

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

Show Source

• Array of: object schema

{
    "title":"Subscription Balance Condition Criteria",
    "type":"array",
    "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageRatingDeterminants-charges-determinantRules-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• BalanceCriteriaDescription: string
  Title: Description

  Maximum Length: 300

  The description of subscription balance criterion.
• BalanceCriteriaNumber: string
  Title: Criteria

  Maximum Length: 120

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

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of the subscription balance criterion.
• CriteriaPrecedence: integer
  Title: Sequence

  The order in which the criteria will be evaluated.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance criterion.
• subscriptionBalancePredicates: array Subscription Balance Condition Predicates
  Title: Subscription Balance Condition Predicates

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

{
    "type":"object",
    "properties":{
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of subscription balance criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":120,
            "type":"string",
            "description":"The unique number of the subscription balance criterion.",
            "nullable":false
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the subscription balance criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CriteriaPrecedence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order in which the criteria will be evaluated.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Condition Predicates",
            "type":"array",
            "description":"The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageRatingDeterminants-charges-determinantRules-subscriptionBalancePredicates-item-patch-request"
            }
        }
    }
}

Nested Schema : Subscription Balance Condition Predicates

Type: array

Title: Subscription Balance Condition Predicates

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

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

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

  Maximum Length: 240

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

  Maximum Length: 120

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

  Maximum Length: 600

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

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

  The balance predicate decimal value of subscription balance predicate.
• BalancePredicateNumberValue: integer
  Title: Value

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

  Maximum Length: 30

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

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

  Maximum Length: 30

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

  The time value of the subscription balance predicate.
• SourceType: string
  Title: Source Type

  Maximum Length: 30

  Default Value: ORA_OSS_USER

  The source type of the subscription balance predicate.

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

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 : subscriptionUsageRatingDeterminants-charges-item-response

Type: object

Show Source

• ChargeDefinition: string
  Title: Charge Definition

  Read Only: true

  Maximum Length: 30

  The charge definition code of the rate plan charge determinant.
• ChargeDefinitionId: integer (int64)
  Title: Charge Definition ID

  Read Only: true

  The unique identifier of charge definition of the subscription entitlement plan commitments.
• ChargeDeterminantId: integer (int64)
  Title: Charge Determinant ID

  Subscription Rate Plan Charges Determinants
• ChargeDeterminantPuid: string
  Title: Charge Determinant Number

  Read Only: true

  Maximum Length: 120

  The alternate key identifier of the rate plan charge determinant.
• ChargeName: string
  Title: Charge Name

  Read Only: true

  Maximum Length: 80

  The charge definition name of the rate plan charge determinant.
• ChargePeriod: string
  Title: Charge Period

  Read Only: true

  Maximum Length: 30

  The period value for the charge determinant.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the rate plan charge determinant.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the rate plan charge determinant was created.
• determinantRules: array Subscription Balance Condition Criteria
  Title: Subscription Balance Condition Criteria

  The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.
• EndTime: string (date-time)
  Title: End Time

  Read Only: true

  The end time of the charge determinant.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the rate plan charge determinant was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who has last updated the rate plan charge determinant.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartialBlockActionCode: string
  Title: Partial Block Action Code

  Read Only: true

  Maximum Length: 30

  The field which tracks how the pricing is calculated in the tiered pricing model, specifically whether it's based on a per unit or block approach.
• PricingTierEnabledFlag: boolean
  Title: Pricing Tier Enabled

  Read Only: true

  Maximum Length: 1

  Indicates whether the pricing is enabled for tier.
• RatePlanDeterminantId: integer (int64)
  Title: Rate Plan Determinant ID

  The unique identifier of the usage rating determinant.
• RatePlanId: integer (int64)
  Title: Rate Plan ID

  Read Only: true

  The unique identifier of the rate plan associated to the subscription product.
• ReportedQuantityAttribute: string
  Title: Reported Quantity

  Maximum Length: 60

  The reported usage quantity which has to be rated.
• ReportedUnitOfMeasureAttribute: string
  Title: Reported UOM

  Maximum Length: 60

  The reported unit of measure attribute name of the subscription event type charge.
• StartTime: string (date-time)
  Title: Start Time

  Read Only: true

  The start time of the charge determinant.
• TierBasisTypeCode: string
  Title: Tier Basis Type Code

  Read Only: true

  Maximum Length: 30

  The volume attribute of the transaction that's used for tier evaluation within a tiered pricing model.
• TierType: string
  Title: Tier Type

  Read Only: true

  Maximum Length: 30

  The specific tier rules that are applied to either the quantity or the amount during the tiered pricing evaluation.
• UnitOfMeasure: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  The unit of measure value for the charge.
• UnitofMeasureClass: string
  Title: Unit of Measure Class

  Read Only: true

  Maximum Length: 10

  The unit of measure class value for the charge determinant.

{
    "type":"object",
    "properties":{
        "ChargeDefinition":{
            "title":"Charge Definition",
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code of the rate plan charge determinant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Definition ID",
            "type":"integer",
            "description":"The unique identifier of charge definition of the subscription entitlement plan commitments.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDeterminantId":{
            "title":"Charge Determinant ID",
            "type":"integer",
            "description":"Subscription Rate Plan Charges Determinants",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDeterminantPuid":{
            "title":"Charge Determinant Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate key identifier of the rate plan charge determinant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeName":{
            "title":"Charge Name",
            "maxLength":80,
            "type":"string",
            "description":"The charge definition name of the rate plan charge determinant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Charge Period",
            "maxLength":30,
            "type":"string",
            "description":"The period value for the charge determinant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the rate plan charge determinant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the rate plan charge determinant was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The end time of the charge determinant.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the rate plan charge determinant was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the rate plan charge determinant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartialBlockActionCode":{
            "title":"Partial Block Action Code",
            "maxLength":30,
            "type":"string",
            "description":"The field which tracks how the pricing is calculated in the tiered pricing model, specifically whether it's based on a per unit or block approach.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricingTierEnabledFlag":{
            "title":"Pricing Tier Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the pricing is enabled for tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RatePlanDeterminantId":{
            "title":"Rate Plan Determinant ID",
            "type":"integer",
            "description":"The unique identifier of the usage rating determinant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RatePlanId":{
            "title":"Rate Plan ID",
            "type":"integer",
            "description":"The unique identifier of the rate plan associated to the subscription product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReportedQuantityAttribute":{
            "title":"Reported Quantity",
            "maxLength":60,
            "type":"string",
            "description":"The reported usage quantity which has to be rated.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ReportedUnitOfMeasureAttribute":{
            "title":"Reported UOM",
            "maxLength":60,
            "type":"string",
            "description":"The reported unit of measure attribute name of the subscription event type charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The start time of the charge determinant.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TierBasisTypeCode":{
            "title":"Tier Basis Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The volume attribute of the transaction that's used for tier evaluation within a tiered pricing model.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TierType":{
            "title":"Tier Type",
            "maxLength":30,
            "type":"string",
            "description":"The specific tier rules that are applied to either the quantity or the amount during the tiered pricing evaluation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure value for the charge.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitofMeasureClass":{
            "title":"Unit of Measure Class",
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure class value for the charge determinant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "determinantRules":{
            "title":"Subscription Balance Condition Criteria",
            "type":"array",
            "description":"The subscription balance criteria resource is used to view, create, update, and delete a balance criteria.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageRatingDeterminants-charges-determinantRules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Subscription Balance Condition Criteria

Type: array

Title: Subscription Balance Condition Criteria

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

Show Source

• Array of: object subscriptionUsageRatingDeterminants-charges-determinantRules-item-response

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : subscriptionUsageRatingDeterminants-charges-determinantRules-item-response

Type: object

Show Source

• BalanceCriteriaDescription: string
  Title: Description

  Maximum Length: 300

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

  Maximum Length: 120

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

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

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

  Maximum Length: 30

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

  Maximum Length: 64

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

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

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

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

  Maximum Length: 64

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

  Maximum Length: 32

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

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

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Subscription Balance Condition Predicates

Type: array

Title: Subscription Balance Condition Predicates

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

Show Source

• Array of: object subscriptionUsageRatingDeterminants-charges-determinantRules-subscriptionBalancePredicates-item-response

{
    "title":"Subscription Balance Condition Predicates",
    "type":"array",
    "description":"The subscription balance predicates resource is used to view, create, update, and delete a balance predicate.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageRatingDeterminants-charges-determinantRules-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 : subscriptionUsageRatingDeterminants-charges-determinantRules-subscriptionBalancePredicates-item-response

Type: object

Show Source

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

  Maximum Length: 240

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

  Maximum Length: 120

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

  Maximum Length: 600

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

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

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

  Maximum Length: 120

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

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

  Maximum Length: 30

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

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

  Maximum Length: 30

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

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

  Maximum Length: 64

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

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

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

  Maximum Length: 64

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

  Maximum Length: 32

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

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

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

  Maximum Length: 30

  Default Value: ORA_OSS_USER

  The source type of the subscription balance predicate.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

determinantRules

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/{RatePlanDeterminantNumber}/child/charges/{ChargeDeterminantPuid}/child/determinantRules

Parameters:

• ChargeDeterminantPuid: $request.path.ChargeDeterminantPuid
• RatePlanDeterminantNumber: $request.path.RatePlanDeterminantNumber

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

Back to Top