Jump to

• Request
• Response
• Examples

Get a usage rating determinant

get

/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/{RatePlanDeterminantNumber}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : subscriptionUsageRatingDeterminants-item-response

Type: object

Show Source

• charges: array Subscription Rate Plan Charges Determinants
  Title: Subscription Rate Plan Charges Determinants

  The subscription rate plan charges determinants criteria resource is used to view, create, update, and delete rate plans and its charge determinants. These rate plan determinants are used to split the usage events based on the rate plan matrix definition.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance consumption predicate.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the subscription balance consumption predicate was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the subscription balance consumption predicate was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number of the subscription balance consumption predicate.
• RatePlanDeterminantId: integer (int64)
  Title: Rate Plan Determinant ID

  The unique identifier of the usage rating determinant.
• RatePlanDeterminantNumber: string
  Title: Number

  Maximum Length: 120

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

  The unique identifier of the rate plan associated to the subscription product.
• RatePlanNumber: string
  Title: Rate Plan Number

  Maximum Length: 120

  The public unique identifier of the rate plan associated with the subscription product.
• SourceType: string
  Title: Source Type

  Maximum Length: 30

  Default Value: ORA_OSS_USER

  The source by which this usage rating determinant is created. It's either System or User.
• Status: string
  Title: Status

  Maximum Length: 30

  The current status of the usage rating determinant. It can be Draft, Active or InActive.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the subscription balance consumption predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The current status of the usage rating determinant. It can be Draft, Active or InActive.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the subscription balance consumption predicate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription balance consumption predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"The source by which this usage rating determinant is created. It's either System or User.",
            "nullable":true,
            "default":"ORA_OSS_USER",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RatePlanNumber":{
            "title":"Rate Plan Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the rate plan associated with the subscription product.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "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",
            "type":"integer",
            "description":"The unique identifier of the rate plan associated to the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "charges":{
            "title":"Subscription Rate Plan Charges Determinants",
            "type":"array",
            "description":"The subscription rate plan charges determinants criteria resource is used to view, create, update, and delete rate plans and its charge determinants. These rate plan determinants are used to split the usage events based on the rate plan matrix definition.",
            "items":{
                "$ref":"#/components/schemas/subscriptionUsageRatingDeterminants-charges-item-response"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number of the subscription balance consumption predicate.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RatePlanDeterminantNumber":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternative identifier of the usage rating determinant.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the subscription balance consumption predicate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Subscription Rate Plan Charges Determinants

Type: array

Title: Subscription Rate Plan Charges Determinants

The subscription rate plan charges determinants criteria resource is used to view, create, update, and delete rate plans and its charge determinants. These rate plan determinants are used to split the usage events based on the rate plan matrix definition.

Show Source

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

{
    "title":"Subscription Rate Plan Charges Determinants",
    "type":"array",
    "description":"The subscription rate plan charges determinants criteria resource is used to view, create, update, and delete rate plans and its charge determinants. These rate plan determinants are used to split the usage events based on the rate plan matrix definition.",
    "items":{
        "$ref":"#/components/schemas/subscriptionUsageRatingDeterminants-charges-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-item-response

Type: object

Show Source

• 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.
• 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 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.
• 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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The end time of the charge determinant.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "ChargeDeterminantId":{
            "title":"Charge Determinant ID",
            "type":"integer",
            "description":"Subscription Rate Plan Charges Determinants",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "determinantRules":{
            "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/subscriptionUsageRatingDeterminants-charges-determinantRules-item-response"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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 subscriptionUsageRatingDeterminants-charges-determinantRules-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/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 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.
• 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 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/subscriptionUsageRatingDeterminants-charges-determinantRules-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
        },
        "CriteriaPrecedence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order in which the criteria will be evaluated.",
            "nullable":true,
            "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 subscriptionUsageRatingDeterminants-charges-determinantRules-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/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 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.
• SourceType: string
  Title: Source Type

  Maximum Length: 30

  Default Value: ORA_OSS_USER

  The source type of the subscription balance 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
        },
        "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
        },
        "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"
    }
}

Links

SourceTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_RATING_SETUP_SOURCE

The following properties are defined on the LOV link relation:

• Source Attribute: SourceType; Target Attribute: LookupCode
• Display Attribute: Meaning

StatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_MGMT_SETUP_STS

The following properties are defined on the LOV link relation:

• Source Attribute: Status; Target Attribute: LookupCode
• Display Attribute: Meaning

activateUsageRatingDeterminant

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/{RatePlanDeterminantNumber}/action/activateUsageRatingDeterminant

Parameters:

• RatePlanDeterminantNumber: $request.path.RatePlanDeterminantNumber

This method lets you activate a usage rating determinant along with its children.

charges

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

Parameters:

• RatePlanDeterminantNumber: $request.path.RatePlanDeterminantNumber

The subscription rate plan charges determinants criteria resource is used to view, create, update, and delete rate plans and its charge determinants. These rate plan determinants are used to split the usage events based on the rate plan matrix definition.

deActivateUsageRatingDeterminant

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/{RatePlanDeterminantNumber}/action/deActivateUsageRatingDeterminant

Parameters:

• RatePlanDeterminantNumber: $request.path.RatePlanDeterminantNumber

This method lets you inactivate a usage rating determinant along with its children.

synchronizeUsageRatingDeterminant

Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/{RatePlanDeterminantNumber}/action/synchronizeUsageRatingDeterminant

Parameters:

• RatePlanDeterminantNumber: $request.path.RatePlanDeterminantNumber

This method lets you synchronize the usage rating determinant charges with the pricing rate plan charges.

Back to Top

Examples

The following example shows how to get a usage rating determinant by submitting a get request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/{RatePlanDeterminantNumber}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "RatePlanDeterminantId": 300100631731073,
    "RatePlanDeterminantNumber": "CDRM_1001",
    "RatePlanId": 300100627351416,
    "RatePlanNumber": "37023",
    "SourceType": "ORA_OSS_USER",
    "Status": "ORA_OSS_DRAFT",
    "ObjectVersionNumber": 1,
    "CreatedBy": "CONMGR",
    "CreationDate": "2025-03-19T02:27:53+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2025-03-19T02:28:27.256+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1001",
            "name": "subscriptionUsageRatingDeterminants",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1001",
            "name": "subscriptionUsageRatingDeterminants",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1001/child/charges",
            "name": "charges",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1001/action/activateUsageRatingDeterminant",
            "name": "activateUsageRatingDeterminant",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1001/action/deActivateUsageRatingDeterminant",
            "name": "deActivateUsageRatingDeterminant",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1001/action/synchronizeUsageRatingDeterminant",
            "name": "synchronizeUsageRatingDeterminant",
            "kind": "other"
        }
    ]
}

Back to Top