1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription Usage Rating Determinants

Get all usage rating determinants

get

/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the rate plan determinant with the specified primary key.
      Finder Variables
      • RatePlanDeterminantId; integer; The unique identifier of the rate plan determinant.
    • RatePlanDeterminantAltKey Finds the rate plan determinant with the specified alternative key.
      Finder Variables
      • RatePlanDeterminantNumber; string; The alternative identifier of the rate plan determinant.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; The user who created the subscription balance consumption predicate.
    • CreationDate; string; The date when the subscription balance consumption predicate was created.
    • LastUpdateDate; string; The date when the subscription balance consumption predicate was last updated.
    • LastUpdatedBy; string; The user who has last updated the subscription balance consumption predicate.
    • ObjectVersionNumber; integer; The object version number of the subscription balance consumption predicate.
    • RatePlanDeterminantId; integer; The unique identifier of the usage rating determinant.
    • RatePlanDeterminantNumber; string; The alternative identifier of the usage rating determinant.
    • RatePlanId; integer; The unique identifier of the rate plan associated to the subscription product.
    • RatePlanNumber; string; The public unique identifier of the rate plan associated with the subscription product.
    • SourceType; string; The source by which this usage rating determinant is created. It's either System or User.
    • Status; string; The current status of the usage rating determinant. It can be Draft, Active or InActive.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : subscriptionUsageRatingDeterminants-item-response
Type: object
Show Source
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the subscription balance consumption predicate.
  • Title: Creation Date
    Read Only: true
    The date when the subscription balance consumption predicate was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the subscription balance consumption predicate was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who has last updated the subscription balance consumption predicate.
  • Links
  • Title: Object Version Number
    The object version number of the subscription balance consumption predicate.
  • Title: Rate Plan Determinant ID
    The unique identifier of the usage rating determinant.
  • Title: Number
    Maximum Length: 120
    The alternative identifier of the usage rating determinant.
  • Title: Rate Plan
    The unique identifier of the rate plan associated to the subscription product.
  • Title: Rate Plan Number
    Maximum Length: 120
    The public unique identifier of the rate plan associated with the subscription product.
  • 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.
  • Title: Status
    Maximum Length: 30
    The current status of the usage rating determinant. It can be Draft, Active or InActive.
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
Nested Schema : subscriptionUsageRatingDeterminants-charges-item-response
Type: object
Show Source
Nested Schema : Subscription Balance Consumption Criteria
Type: array
Title: Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : subscriptionUsageRatingDeterminants-charges-determinantRules-item-response
Type: object
Show Source
Nested Schema : Subscription Balance Consumption Predicates
Type: array
Title: Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : subscriptionUsageRatingDeterminants-charges-determinantRules-subscriptionBalancePredicates-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all usage rating determinants 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

Example of Response Body

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

{
    "items": [
        {
            "RatePlanDeterminantId": 300100632016443,
            "RatePlanDeterminantNumber": "CDRM_1007",
            "RatePlanId": 300100631854544,
            "RatePlanNumber": "82012",
            "SourceType": "ORA_OSS_USER",
            "Status": "ORA_OSS_ACTIVE",
            "ObjectVersionNumber": 1,
            "CreatedBy": "CONMGR",
            "CreationDate": "2025-03-19T16:52:37+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2025-03-19T16:56:21.546+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1007",
                    "name": "subscriptionUsageRatingDeterminants",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1007",
                    "name": "subscriptionUsageRatingDeterminants",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1007/child/charges",
                    "name": "charges",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1007/action/activateUsageRatingDeterminant",
                    "name": "activateUsageRatingDeterminant",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1007/action/deActivateUsageRatingDeterminant",
                    "name": "deActivateUsageRatingDeterminant",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants/CDRM_1007/action/synchronizeUsageRatingDeterminant",
                    "name": "synchronizeUsageRatingDeterminant",
                    "kind": "other"
                }
            ]
        },...
    ],
    "count": 4,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionUsageRatingDeterminants",
            "name": "subscriptionUsageRatingDeterminants",
            "kind": "collection"
        }
    ]
}
Back to Top