REST API for Oracle Commerce Cloud

Retrieves the Subscription product pricing charges

get

/ccstore/v1/selfservice/subscriptionProducts/{id}/charges

based on id.

Request

Supported Media Types

application/json

Path Parameters

id(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.
q: string

parameters to filter the result.
totalResults: boolean

it provides the number of total results. Default is false

Response

Supported Media Types

application/json

200 Response

Response containing the subscription product detail

Root Schema : getSubscriptionProductPricingCharges_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 Items

Title: Items

The items in the collection.
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 items in the collection.",
            "title":"Items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "ChargePuid":{
                        "description":"The public unique identifier of the charge.",
                        "type":"string",
                        "maxLength":120
                    },
                    "UnitListPrice":{
                        "description":"The price of the unit list.",
                        "title":"List Price",
                        "type":"number"
                    },
                    "ChargeDefinition":{
                        "description":"The definition that indicates the purpose of the charge.",
                        "title":"Charge Name",
                        "type":"string",
                        "maxLength":30
                    },
                    "ChargeName":{
                        "description":"The name of the charge.",
                        "title":"Charge Name",
                        "type":"string",
                        "maxLength":120
                    },
                    "Allowance":{
                        "description":"The allowance part of the charge.",
                        "title":"Allowance",
                        "type":"number"
                    },
                    "PriceType":{
                        "description":"The price type associated with the charge.",
                        "type":"string",
                        "maxLength":30
                    }
                }
            }
        }
    },
    "example":{
        "offset":0,
        "count":3,
        "hasMore":false,
        "limit":25,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/BIQA_OTBI_SM5-PRDT-8012/charges"
            }
        ],
        "items":[
            {
                "ChargePuid":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7055",
                "UnitListPrice":"2000",
                "ChargeDefinition":"QP_SALE_PRICE",
                "ChargeName":"Activation Fee",
                "Allowance":null,
                "PriceType":"ONE_TIME",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7055"
                }
            },
            {
                "ChargePuid":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7057",
                "UnitListPrice":"10",
                "ChargeDefinition":"USAGE_CHARGESPM",
                "ChargeName":"USAGE SPM CHARGE",
                "Allowance":null,
                "PriceType":"RECURRING",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    },
                    "key":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7057"
                }
            },
            {
                "ChargePuid":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7056",
                "UnitListPrice":"200",
                "ChargeDefinition":"QP_RECURRING_SALE_PRICE",
                "ChargeName":"Monthly Fee",
                "Allowance":null,
                "PriceType":"RECURRING",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7056"
                }
            }
        ]
    }
}

Example:

{
    "offset":0,
    "count":3,
    "hasMore":false,
    "limit":25,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/BIQA_OTBI_SM5-PRDT-8012/charges"
        }
    ],
    "items":[
        {
            "ChargePuid":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7055",
            "UnitListPrice":"2000",
            "ChargeDefinition":"QP_SALE_PRICE",
            "ChargeName":"Activation Fee",
            "Allowance":null,
            "PriceType":"ONE_TIME",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7055"
            }
        },
        {
            "ChargePuid":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7057",
            "UnitListPrice":"10",
            "ChargeDefinition":"USAGE_CHARGESPM",
            "ChargeName":"USAGE SPM CHARGE",
            "Allowance":null,
            "PriceType":"RECURRING",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                },
                "key":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7057"
            }
        },
        {
            "ChargePuid":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7056",
            "UnitListPrice":"200",
            "ChargeDefinition":"QP_RECURRING_SALE_PRICE",
            "ChargeName":"Monthly Fee",
            "Allowance":null,
            "PriceType":"RECURRING",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"BIQA_OTBI_SM5-PRDT-8012-CHRG-7056"
            }
        }
    ]
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object items

{
    "description":"The items in the collection.",
    "title":"Items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ChargePuid":{
                "description":"The public unique identifier of the charge.",
                "type":"string",
                "maxLength":120
            },
            "UnitListPrice":{
                "description":"The price of the unit list.",
                "title":"List Price",
                "type":"number"
            },
            "ChargeDefinition":{
                "description":"The definition that indicates the purpose of the charge.",
                "title":"Charge Name",
                "type":"string",
                "maxLength":30
            },
            "ChargeName":{
                "description":"The name of the charge.",
                "title":"Charge Name",
                "type":"string",
                "maxLength":120
            },
            "Allowance":{
                "description":"The allowance part of the charge.",
                "title":"Allowance",
                "type":"number"
            },
            "PriceType":{
                "description":"The price type associated with the charge.",
                "type":"string",
                "maxLength":30
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

Allowance: number

Title: Allowance

The allowance part of the charge.
ChargeDefinition: string

Title: Charge Name

Maximum Length: 30

The definition that indicates the purpose of the charge.
ChargeName: string

Title: Charge Name

Maximum Length: 120

The name of the charge.
ChargePuid: string

Maximum Length: 120

The public unique identifier of the charge.
PriceType: string

Maximum Length: 30

The price type associated with the charge.
UnitListPrice: number

Title: List Price

The price of the unit list.

{
    "type":"object",
    "properties":{
        "ChargePuid":{
            "description":"The public unique identifier of the charge.",
            "type":"string",
            "maxLength":120
        },
        "UnitListPrice":{
            "description":"The price of the unit list.",
            "title":"List Price",
            "type":"number"
        },
        "ChargeDefinition":{
            "description":"The definition that indicates the purpose of the charge.",
            "title":"Charge Name",
            "type":"string",
            "maxLength":30
        },
        "ChargeName":{
            "description":"The name of the charge.",
            "title":"Charge Name",
            "type":"string",
            "maxLength":120
        },
        "Allowance":{
            "description":"The allowance part of the charge.",
            "title":"Allowance",
            "type":"number"
        },
        "PriceType":{
            "description":"The price type associated with the charge.",
            "type":"string",
            "maxLength":30
        }
    }
}

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|

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"
        }
    }
}