REST API for Oracle Commerce Cloud

Retrieves all active subscriptions associated with the organization of logged in profile

get

/ccstore/v1/selfservice/subscriptionProducts

in the currently authenticated session. If the profile is not logged in or is anonymous then the endpoint will fail. The endpoint will responds with same data what is received from corresponding subscription endpoint

Request

Supported Media Types

application/json

Query Parameters

limit: string

The batch size of the subscription products 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

q param supported by Fusion API. It does not support any party q param

Response

Supported Media Types

application/json

200 Response

Response containing the list of subscription products

Root Schema : getSubscriptionProducts_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":{
                    "Status":{
                        "description":"The status of the subscription product.",
                        "title":"Status",
                        "type":"string",
                        "maxLength":30
                    },
                    "SalesProductType":{
                        "description":"The type of the sales product.",
                        "title":"Type",
                        "type":"string",
                        "maxLength":30
                    },
                    "SubscriptionNumber":{
                        "description":"The subscription number of the product.",
                        "title":"Subscription Number",
                        "type":"string",
                        "maxLength":120
                    },
                    "Description":{
                        "description":"A brief description of the subscription product.",
                        "title":"Product Description",
                        "type":"string"
                    },
                    "ProductName":{
                        "description":"The name of the product.",
                        "title":"Product Name",
                        "type":"string",
                        "maxLength":300
                    },
                    "BillingFrequency":{
                        "description":"The billing frequency.",
                        "title":"Billing Frequency",
                        "type":"string",
                        "maxLength":30
                    },
                    "TotalContractValue":{
                        "description":"The value of the total contract.",
                        "title":"Product Contract Value",
                        "type":"number"
                    },
                    "SubscriptionProductPuid":{
                        "description":"The public unique identifier of the subscription product.",
                        "title":"Subscription Product Number",
                        "type":"string",
                        "maxLength":120
                    },
                    "Quantity":{
                        "description":"The quantity of the product.",
                        "title":"Quantity",
                        "type":"number"
                    },
                    "BillingFrequencyName":{
                        "description":"The name of the billing frequency.",
                        "title":"Billing Frequency",
                        "type":"string"
                    },
                    "EndDate":{
                        "description":"The date when the subscriptions ends.",
                        "title":"Product End Date",
                        "type":"string"
                    },
                    "StartDate":{
                        "format":"date",
                        "description":"The date when the subscriptions starts.",
                        "title":"Product Start Date",
                        "type":"string"
                    },
                    "StatusMeaning":{
                        "description":"The meaning of the product status.",
                        "readOnly":true,
                        "title":"Product Status",
                        "type":"string",
                        "maxLength":80
                    },
                    "Currency":{
                        "description":"The currency associated with the subscription product.",
                        "type":"string",
                        "maxLength":15
                    }
                }
            }
        }
    },
    "example":{
        "totalResults":111,
        "offset":0,
        "count":10,
        "hasMore":true,
        "limit":10,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts?totalResults=true&limit=10"
            },
            {
                "rel":"next",
                "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts?totalResults=true&limit=10&offset=10"
            }
        ],
        "items":[
            {
                "Status":"ORA_DRAFT",
                "SalesProductType":"SUBSCRIPTION",
                "SubscriptionNumber":"BIQA_OTBI_SM10",
                "Description":"National Geographic Subscription",
                "ProductName":"ZOSS_SubscriptionItem003_AUTO",
                "BillingFrequency":"0zG",
                "TotalContractValue":"1500",
                "SubscriptionProductPuid":"BIQA_OTBI_SM10-PRDT-8022",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-05-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"BIQA_OTBI_SM10-PRDT-8022"
                },
                "StartDate":"2019-01-01",
                "StatusMeaning":"Draft",
                "Currency":"INR"
            },
            {
                "Status":"ORA_DRAFT",
                "SalesProductType":"SOFTWARE_MAINTENANCE",
                "SubscriptionNumber":"BIQA_OTBI_SM10",
                "Description":"ZOKC_COVG_Item002 - MONTH",
                "ProductName":"ZOKC_COVG_Item002",
                "BillingFrequency":"0zG",
                "TotalContractValue":"0",
                "SubscriptionProductPuid":"BIQA_OTBI_SM10-PRDT-8023",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-05-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"BIQA_OTBI_SM10-PRDT-8023"
                },
                "StartDate":"2019-01-01",
                "StatusMeaning":"Draft",
                "Currency":"INR"
            },
            {
                "Status":"ORA_DRAFT",
                "SalesProductType":"COVERAGE",
                "SubscriptionNumber":"CDRM_5001",
                "Description":"ZOKC_COVG_Item001 - YEAR",
                "ProductName":"ZOKC_COVG_Item001",
                "BillingFrequency":"0zG",
                "TotalContractValue":null,
                "SubscriptionProductPuid":"CDRM_5001-PRDT-4002",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-09-30",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"CDRM_5001-PRDT-4002"
                },
                "StartDate":"2019-07-01",
                "StatusMeaning":"Draft",
                "Currency":"USD"
            },
            {
                "Status":"ORA_DRAFT",
                "SalesProductType":"SUBSCRIPTION",
                "SubscriptionNumber":"CDRM_5001",
                "Description":"Subscription Item",
                "ProductName":"ZOSS_SubscriptionItem001_AUTO",
                "BillingFrequency":"0zG",
                "TotalContractValue":"1310",
                "SubscriptionProductPuid":"CDRM_5001-PRDT-4001",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-09-30",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"CDRM_5001-PRDT-4001"
                },
                "StartDate":"2019-07-01",
                "StatusMeaning":"Draft",
                "Currency":"USD"
            },
            {
                "Status":"ORA_CANCELED",
                "SalesProductType":"SOFTWARE_MAINTENANCE",
                "SubscriptionNumber":"BIQA_OTBI_SM12",
                "Description":"ZOKC_COVG_Item002 - MONTH",
                "ProductName":"ZOKC_COVG_Item002",
                "BillingFrequency":"0zG",
                "TotalContractValue":"0",
                "SubscriptionProductPuid":"BIQA_OTBI_SM12-PRDT-8027",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-12-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"BIQA_OTBI_SM12-PRDT-8027"
                },
                "StartDate":"2019-01-01",
                "StatusMeaning":"Canceled",
                "Currency":"USD"
            },
            {
                "Status":"ORA_EXPIRED",
                "SalesProductType":"SUBSCRIPTION",
                "SubscriptionNumber":"BIQA_OTBI_SM13",
                "Description":"Subscription Item",
                "ProductName":"ZOSS_SubscriptionItem002_AUTO",
                "BillingFrequency":"0zG",
                "TotalContractValue":"2200",
                "SubscriptionProductPuid":"BIQA_OTBI_SM13-PRDT-8028",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-12-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"BIQA_OTBI_SM13-PRDT-8028"
                },
                "StartDate":"2019-01-01",
                "StatusMeaning":"Expired",
                "Currency":"USD"
            },
            {
                "Status":"ORA_DRAFT",
                "SalesProductType":"SUBSCRIPTION",
                "SubscriptionNumber":"CDRM_6001",
                "Description":"Subscription Item",
                "ProductName":"ZOSS_SubscriptionItem001_AUTO",
                "BillingFrequency":"0zG",
                "TotalContractValue":"2210",
                "SubscriptionProductPuid":"CDRM_6001-PRDT-5004",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-12-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"CDRM_6001-PRDT-5004"
                },
                "StartDate":"2019-01-01",
                "StatusMeaning":"Draft",
                "Currency":"USD"
            },
            {
                "Status":"ORA_DRAFT",
                "SalesProductType":"SUBSCRIPTION",
                "SubscriptionNumber":"CDRM_6001",
                "Description":"Subscription Item",
                "ProductName":"ZOSS_SubscriptionItem002_AUTO",
                "BillingFrequency":"0zG",
                "TotalContractValue":"4410",
                "SubscriptionProductPuid":"CDRM_6001-PRDT-5001",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-12-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"CDRM_6001-PRDT-5001"
                },
                "StartDate":"2019-01-01",
                "StatusMeaning":"Draft",
                "Currency":"USD"
            },
            {
                "Status":"ORA_EXPIRED",
                "SalesProductType":"SUBSCRIPTION",
                "SubscriptionNumber":"BIQA_OTBI_SM12",
                "Description":"National Geographic Subscription",
                "ProductName":"ZOSS_SubscriptionItem003_AUTO",
                "BillingFrequency":"0zG",
                "TotalContractValue":"2200",
                "SubscriptionProductPuid":"BIQA_OTBI_SM12-PRDT-8026",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-12-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"BIQA_OTBI_SM12-PRDT-8026"
                },
                "StartDate":"2019-01-01",
                "StatusMeaning":"Expired",
                "Currency":"USD"
            },
            {
                "Status":"ORA_EXPIRED",
                "SalesProductType":"SUBSCRIPTION",
                "SubscriptionNumber":"BIQA_OTBI_SM4",
                "Description":"Subscription Item",
                "ProductName":"ZOSS_SubscriptionItem001_AUTO",
                "BillingFrequency":"0zG",
                "TotalContractValue":"2200",
                "SubscriptionProductPuid":"BIQA_OTBI_SM4-PRDT-8010",
                "Quantity":"1",
                "BillingFrequencyName":"MONTH",
                "EndDate":"2019-12-31",
                "@context":{
                    "headers":{
                        "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    },
                    "key":"BIQA_OTBI_SM4-PRDT-8010"
                },
                "StartDate":"2019-01-01",
                "StatusMeaning":"Expired",
                "Currency":"USD"
            }
        ]
    }
}

Example:

{
    "totalResults":111,
    "offset":0,
    "count":10,
    "hasMore":true,
    "limit":10,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts?totalResults=true&limit=10"
        },
        {
            "rel":"next",
            "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts?totalResults=true&limit=10&offset=10"
        }
    ],
    "items":[
        {
            "Status":"ORA_DRAFT",
            "SalesProductType":"SUBSCRIPTION",
            "SubscriptionNumber":"BIQA_OTBI_SM10",
            "Description":"National Geographic Subscription",
            "ProductName":"ZOSS_SubscriptionItem003_AUTO",
            "BillingFrequency":"0zG",
            "TotalContractValue":"1500",
            "SubscriptionProductPuid":"BIQA_OTBI_SM10-PRDT-8022",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-05-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"BIQA_OTBI_SM10-PRDT-8022"
            },
            "StartDate":"2019-01-01",
            "StatusMeaning":"Draft",
            "Currency":"INR"
        },
        {
            "Status":"ORA_DRAFT",
            "SalesProductType":"SOFTWARE_MAINTENANCE",
            "SubscriptionNumber":"BIQA_OTBI_SM10",
            "Description":"ZOKC_COVG_Item002 - MONTH",
            "ProductName":"ZOKC_COVG_Item002",
            "BillingFrequency":"0zG",
            "TotalContractValue":"0",
            "SubscriptionProductPuid":"BIQA_OTBI_SM10-PRDT-8023",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-05-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"BIQA_OTBI_SM10-PRDT-8023"
            },
            "StartDate":"2019-01-01",
            "StatusMeaning":"Draft",
            "Currency":"INR"
        },
        {
            "Status":"ORA_DRAFT",
            "SalesProductType":"COVERAGE",
            "SubscriptionNumber":"CDRM_5001",
            "Description":"ZOKC_COVG_Item001 - YEAR",
            "ProductName":"ZOKC_COVG_Item001",
            "BillingFrequency":"0zG",
            "TotalContractValue":null,
            "SubscriptionProductPuid":"CDRM_5001-PRDT-4002",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-09-30",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"CDRM_5001-PRDT-4002"
            },
            "StartDate":"2019-07-01",
            "StatusMeaning":"Draft",
            "Currency":"USD"
        },
        {
            "Status":"ORA_DRAFT",
            "SalesProductType":"SUBSCRIPTION",
            "SubscriptionNumber":"CDRM_5001",
            "Description":"Subscription Item",
            "ProductName":"ZOSS_SubscriptionItem001_AUTO",
            "BillingFrequency":"0zG",
            "TotalContractValue":"1310",
            "SubscriptionProductPuid":"CDRM_5001-PRDT-4001",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-09-30",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"CDRM_5001-PRDT-4001"
            },
            "StartDate":"2019-07-01",
            "StatusMeaning":"Draft",
            "Currency":"USD"
        },
        {
            "Status":"ORA_CANCELED",
            "SalesProductType":"SOFTWARE_MAINTENANCE",
            "SubscriptionNumber":"BIQA_OTBI_SM12",
            "Description":"ZOKC_COVG_Item002 - MONTH",
            "ProductName":"ZOKC_COVG_Item002",
            "BillingFrequency":"0zG",
            "TotalContractValue":"0",
            "SubscriptionProductPuid":"BIQA_OTBI_SM12-PRDT-8027",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-12-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"BIQA_OTBI_SM12-PRDT-8027"
            },
            "StartDate":"2019-01-01",
            "StatusMeaning":"Canceled",
            "Currency":"USD"
        },
        {
            "Status":"ORA_EXPIRED",
            "SalesProductType":"SUBSCRIPTION",
            "SubscriptionNumber":"BIQA_OTBI_SM13",
            "Description":"Subscription Item",
            "ProductName":"ZOSS_SubscriptionItem002_AUTO",
            "BillingFrequency":"0zG",
            "TotalContractValue":"2200",
            "SubscriptionProductPuid":"BIQA_OTBI_SM13-PRDT-8028",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-12-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"BIQA_OTBI_SM13-PRDT-8028"
            },
            "StartDate":"2019-01-01",
            "StatusMeaning":"Expired",
            "Currency":"USD"
        },
        {
            "Status":"ORA_DRAFT",
            "SalesProductType":"SUBSCRIPTION",
            "SubscriptionNumber":"CDRM_6001",
            "Description":"Subscription Item",
            "ProductName":"ZOSS_SubscriptionItem001_AUTO",
            "BillingFrequency":"0zG",
            "TotalContractValue":"2210",
            "SubscriptionProductPuid":"CDRM_6001-PRDT-5004",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-12-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"CDRM_6001-PRDT-5004"
            },
            "StartDate":"2019-01-01",
            "StatusMeaning":"Draft",
            "Currency":"USD"
        },
        {
            "Status":"ORA_DRAFT",
            "SalesProductType":"SUBSCRIPTION",
            "SubscriptionNumber":"CDRM_6001",
            "Description":"Subscription Item",
            "ProductName":"ZOSS_SubscriptionItem002_AUTO",
            "BillingFrequency":"0zG",
            "TotalContractValue":"4410",
            "SubscriptionProductPuid":"CDRM_6001-PRDT-5001",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-12-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"CDRM_6001-PRDT-5001"
            },
            "StartDate":"2019-01-01",
            "StatusMeaning":"Draft",
            "Currency":"USD"
        },
        {
            "Status":"ORA_EXPIRED",
            "SalesProductType":"SUBSCRIPTION",
            "SubscriptionNumber":"BIQA_OTBI_SM12",
            "Description":"National Geographic Subscription",
            "ProductName":"ZOSS_SubscriptionItem003_AUTO",
            "BillingFrequency":"0zG",
            "TotalContractValue":"2200",
            "SubscriptionProductPuid":"BIQA_OTBI_SM12-PRDT-8026",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-12-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"BIQA_OTBI_SM12-PRDT-8026"
            },
            "StartDate":"2019-01-01",
            "StatusMeaning":"Expired",
            "Currency":"USD"
        },
        {
            "Status":"ORA_EXPIRED",
            "SalesProductType":"SUBSCRIPTION",
            "SubscriptionNumber":"BIQA_OTBI_SM4",
            "Description":"Subscription Item",
            "ProductName":"ZOSS_SubscriptionItem001_AUTO",
            "BillingFrequency":"0zG",
            "TotalContractValue":"2200",
            "SubscriptionProductPuid":"BIQA_OTBI_SM4-PRDT-8010",
            "Quantity":"1",
            "BillingFrequencyName":"MONTH",
            "EndDate":"2019-12-31",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"BIQA_OTBI_SM4-PRDT-8010"
            },
            "StartDate":"2019-01-01",
            "StatusMeaning":"Expired",
            "Currency":"USD"
        }
    ]
}

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":{
            "Status":{
                "description":"The status of the subscription product.",
                "title":"Status",
                "type":"string",
                "maxLength":30
            },
            "SalesProductType":{
                "description":"The type of the sales product.",
                "title":"Type",
                "type":"string",
                "maxLength":30
            },
            "SubscriptionNumber":{
                "description":"The subscription number of the product.",
                "title":"Subscription Number",
                "type":"string",
                "maxLength":120
            },
            "Description":{
                "description":"A brief description of the subscription product.",
                "title":"Product Description",
                "type":"string"
            },
            "ProductName":{
                "description":"The name of the product.",
                "title":"Product Name",
                "type":"string",
                "maxLength":300
            },
            "BillingFrequency":{
                "description":"The billing frequency.",
                "title":"Billing Frequency",
                "type":"string",
                "maxLength":30
            },
            "TotalContractValue":{
                "description":"The value of the total contract.",
                "title":"Product Contract Value",
                "type":"number"
            },
            "SubscriptionProductPuid":{
                "description":"The public unique identifier of the subscription product.",
                "title":"Subscription Product Number",
                "type":"string",
                "maxLength":120
            },
            "Quantity":{
                "description":"The quantity of the product.",
                "title":"Quantity",
                "type":"number"
            },
            "BillingFrequencyName":{
                "description":"The name of the billing frequency.",
                "title":"Billing Frequency",
                "type":"string"
            },
            "EndDate":{
                "description":"The date when the subscriptions ends.",
                "title":"Product End Date",
                "type":"string"
            },
            "StartDate":{
                "format":"date",
                "description":"The date when the subscriptions starts.",
                "title":"Product Start Date",
                "type":"string"
            },
            "StatusMeaning":{
                "description":"The meaning of the product status.",
                "readOnly":true,
                "title":"Product Status",
                "type":"string",
                "maxLength":80
            },
            "Currency":{
                "description":"The currency associated with the subscription product.",
                "type":"string",
                "maxLength":15
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

BillingFrequency: string

Title: Billing Frequency

Maximum Length: 30

The billing frequency.
BillingFrequencyName: string

Title: Billing Frequency

The name of the billing frequency.
Currency: string

Maximum Length: 15

The currency associated with the subscription product.
Description: string

Title: Product Description

A brief description of the subscription product.
EndDate: string

Title: Product End Date

The date when the subscriptions ends.
ProductName: string

Title: Product Name

Maximum Length: 300

The name of the product.
Quantity: number

Title: Quantity

The quantity of the product.
SalesProductType: string

Title: Type

Maximum Length: 30

The type of the sales product.
StartDate: string(date)

Title: Product Start Date

The date when the subscriptions starts.
Status: string

Title: Status

Maximum Length: 30

The status of the subscription product.
StatusMeaning: string

Title: Product Status

Read Only: true

Maximum Length: 80

The meaning of the product status.
SubscriptionNumber: string

Title: Subscription Number

Maximum Length: 120

The subscription number of the product.
SubscriptionProductPuid: string

Title: Subscription Product Number

Maximum Length: 120

The public unique identifier of the subscription product.
TotalContractValue: number

Title: Product Contract Value

The value of the total contract.

{
    "type":"object",
    "properties":{
        "Status":{
            "description":"The status of the subscription product.",
            "title":"Status",
            "type":"string",
            "maxLength":30
        },
        "SalesProductType":{
            "description":"The type of the sales product.",
            "title":"Type",
            "type":"string",
            "maxLength":30
        },
        "SubscriptionNumber":{
            "description":"The subscription number of the product.",
            "title":"Subscription Number",
            "type":"string",
            "maxLength":120
        },
        "Description":{
            "description":"A brief description of the subscription product.",
            "title":"Product Description",
            "type":"string"
        },
        "ProductName":{
            "description":"The name of the product.",
            "title":"Product Name",
            "type":"string",
            "maxLength":300
        },
        "BillingFrequency":{
            "description":"The billing frequency.",
            "title":"Billing Frequency",
            "type":"string",
            "maxLength":30
        },
        "TotalContractValue":{
            "description":"The value of the total contract.",
            "title":"Product Contract Value",
            "type":"number"
        },
        "SubscriptionProductPuid":{
            "description":"The public unique identifier of the subscription product.",
            "title":"Subscription Product Number",
            "type":"string",
            "maxLength":120
        },
        "Quantity":{
            "description":"The quantity of the product.",
            "title":"Quantity",
            "type":"number"
        },
        "BillingFrequencyName":{
            "description":"The name of the billing frequency.",
            "title":"Billing Frequency",
            "type":"string"
        },
        "EndDate":{
            "description":"The date when the subscriptions ends.",
            "title":"Product End Date",
            "type":"string"
        },
        "StartDate":{
            "format":"date",
            "description":"The date when the subscriptions starts.",
            "title":"Product Start Date",
            "type":"string"
        },
        "StatusMeaning":{
            "description":"The meaning of the product status.",
            "readOnly":true,
            "title":"Product Status",
            "type":"string",
            "maxLength":80
        },
        "Currency":{
            "description":"The currency associated with the subscription product.",
            "type":"string",
            "maxLength":15
        }
    }
}

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