Jump to

• Request
• Response

Retrieves the subscription product usages trend

get

/ccstore/v1/selfservice/subscriptionProducts/{subscriptionProductPuId}/subscriptionBalanceRegisters/{balanceRegisterId}/registerAllowances

based on id and balance register id.

Request

Supported Media Types

• application/json

Path Parameters

• balanceRegisterId(required): string
  balance register id.
• subscriptionProductPuId(required): string
  ID of subscription product.

Query Parameters

• limit: string
  The batch size of the subscription products covered assets to be fetched together. Default limit is 25, max limit is also 25
• offset: string
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by. Default value is GrantDate.
• q: string
  parameters to filter the result.
• totalResults: boolean
  it provides the number of total results. Default is false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response containing the subscription product detail

Body ()

Root Schema : getSubscriptionProductUsagesTrend_Response

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Balance Register allowances Items
  Title: Balance Register allowances Items

  The Balance Register allowances Items resource manages the items in a Balance Register.
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included.",
            "type":"integer"
        },
        "offset":{
            "description":"The offset value used in the current page.",
            "type":"integer"
        },
        "count":{
            "description":"The number of resource instances returned in the current range.",
            "type":"integer"
        },
        "hasMore":{
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "type":"boolean"
        },
        "limit":{
            "description":"The actual paging size used by the server.",
            "type":"integer"
        },
        "items":{
            "description":"The Balance Register allowances Items resource manages the items in a Balance Register.",
            "title":"Balance Register allowances Items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "StartDate":{
                        "format":"date",
                        "description":"The date when the Balance Register allowances starts.",
                        "title":"Balance Register allowances Start Date",
                        "type":"string"
                    },
                    "CurrencyCode":{
                        "description":"The currency code associated.",
                        "type":"string",
                        "maxLength":15
                    },
                    "ConsumedQuantity":{
                        "description":"Quantity consumed",
                        "title":"Consumed Quantity",
                        "type":"string"
                    },
                    "RemainingQuantity":{
                        "description":"Quantity Remaining",
                        "title":"Remaining Quantity",
                        "type":"string"
                    },
                    "ConsumedAmount":{
                        "description":"Quantity Amount",
                        "title":"Consumed Amount",
                        "type":"string"
                    },
                    "Amount":{
                        "description":"The amount for which the allowance is registered.",
                        "title":"Amount",
                        "type":"number"
                    },
                    "QuantityUnitOfMeasure":{
                        "description":"Unit of measure for quantity.",
                        "title":"Unit of measure",
                        "type":"string"
                    },
                    "Quantity":{
                        "description":"The quantity of the product.",
                        "title":"Quantity",
                        "type":"number"
                    },
                    "EndDate":{
                        "description":"The date when the Balance Register allowances ends.",
                        "title":"Balance Register allowances End Date",
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "offset":0,
        "count":1,
        "hasMore":false,
        "limit":25,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/4821-002-PRDT-28059/subscriptionBalanceRegisters/CDRM_1009/registerAllowances?q=StartDate%20%3C=%272024-03-27%27%20AND%20EndDate%20%3E=%272024-03-27%27"
            }
        ],
        "items":[
            {
                "CurrencyCode":null,
                "StartDate":"2024-03-01",
                "ConsumedQuantity":"0",
                "RemainingQuantity":"0",
                "ConsumedAmount":null,
                "Amount":null,
                "QuantityUnitOfMeasure":"Ea",
                "Quantity":"20000",
                "EndDate":"2024-03-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"CDRM_1009-BARA-109"
                },
                "RemainingAmount":null
            }
        ]
    }
}

Example:

{
    "offset":0,
    "count":1,
    "hasMore":false,
    "limit":25,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/4821-002-PRDT-28059/subscriptionBalanceRegisters/CDRM_1009/registerAllowances?q=StartDate%20%3C=%272024-03-27%27%20AND%20EndDate%20%3E=%272024-03-27%27"
        }
    ],
    "items":[
        {
            "CurrencyCode":null,
            "StartDate":"2024-03-01",
            "ConsumedQuantity":"0",
            "RemainingQuantity":"0",
            "ConsumedAmount":null,
            "Amount":null,
            "QuantityUnitOfMeasure":"Ea",
            "Quantity":"20000",
            "EndDate":"2024-03-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"CDRM_1009-BARA-109"
            },
            "RemainingAmount":null
        }
    ]
}

Nested Schema : Balance Register allowances Items

Type: array

Title: Balance Register allowances Items

The Balance Register allowances Items resource manages the items in a Balance Register.

Show Source

• Array of: object items

{
    "description":"The Balance Register allowances Items resource manages the items in a Balance Register.",
    "title":"Balance Register allowances Items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "StartDate":{
                "format":"date",
                "description":"The date when the Balance Register allowances starts.",
                "title":"Balance Register allowances Start Date",
                "type":"string"
            },
            "CurrencyCode":{
                "description":"The currency code associated.",
                "type":"string",
                "maxLength":15
            },
            "ConsumedQuantity":{
                "description":"Quantity consumed",
                "title":"Consumed Quantity",
                "type":"string"
            },
            "RemainingQuantity":{
                "description":"Quantity Remaining",
                "title":"Remaining Quantity",
                "type":"string"
            },
            "ConsumedAmount":{
                "description":"Quantity Amount",
                "title":"Consumed Amount",
                "type":"string"
            },
            "Amount":{
                "description":"The amount for which the allowance is registered.",
                "title":"Amount",
                "type":"number"
            },
            "QuantityUnitOfMeasure":{
                "description":"Unit of measure for quantity.",
                "title":"Unit of measure",
                "type":"string"
            },
            "Quantity":{
                "description":"The quantity of the product.",
                "title":"Quantity",
                "type":"number"
            },
            "EndDate":{
                "description":"The date when the Balance Register allowances ends.",
                "title":"Balance Register allowances End Date",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount for which the allowance is registered.
• ConsumedAmount: string
  Title: Consumed Amount

  Quantity Amount
• ConsumedQuantity: string
  Title: Consumed Quantity

  Quantity consumed
• CurrencyCode: string
  Maximum Length: 15

  The currency code associated.
• EndDate: string
  Title: Balance Register allowances End Date

  The date when the Balance Register allowances ends.
• Quantity: number
  Title: Quantity

  The quantity of the product.
• QuantityUnitOfMeasure: string
  Title: Unit of measure

  Unit of measure for quantity.
• RemainingQuantity: string
  Title: Remaining Quantity

  Quantity Remaining
• StartDate: string(date)
  Title: Balance Register allowances Start Date

  The date when the Balance Register allowances starts.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "format":"date",
            "description":"The date when the Balance Register allowances starts.",
            "title":"Balance Register allowances Start Date",
            "type":"string"
        },
        "CurrencyCode":{
            "description":"The currency code associated.",
            "type":"string",
            "maxLength":15
        },
        "ConsumedQuantity":{
            "description":"Quantity consumed",
            "title":"Consumed Quantity",
            "type":"string"
        },
        "RemainingQuantity":{
            "description":"Quantity Remaining",
            "title":"Remaining Quantity",
            "type":"string"
        },
        "ConsumedAmount":{
            "description":"Quantity Amount",
            "title":"Consumed Amount",
            "type":"string"
        },
        "Amount":{
            "description":"The amount for which the allowance is registered.",
            "title":"Amount",
            "type":"number"
        },
        "QuantityUnitOfMeasure":{
            "description":"Unit of measure for quantity.",
            "title":"Unit of measure",
            "type":"string"
        },
        "Quantity":{
            "description":"The quantity of the product.",
            "title":"Quantity",
            "type":"number"
        },
        "EndDate":{
            "description":"The date when the Balance Register allowances ends.",
            "title":"Balance Register allowances End Date",
            "type":"string"
        }
    }
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |59000|If there is a missing required property.| |59002|If request can't be processed currently.| |59003|If there is any invalid path parameter| |59004|If resource is not found| |59005|If error occurred while processing input.| |59008|If any issue occurred while triggering the fusion.| |59010|If self service is not enabled|

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top