Listing subscription products

post

/ccstore/v1/selfservice/subscriptionProducts/search

Lists the subscription products across subscriptions

Request

Supported Media Types
Body ()
Request payload to list subscription products
Root Schema : subscriptionProductSearchRequest
Type: object
Show Source
Example:
{
    "q":{
        "criteria":[
            {
                "op":"$eq",
                "attribute":"SubscriptionId.SubscriptionNumber",
                "value":"CDRM_63367"
            },
            {
                "op":"$eq",
                "attribute":"Status",
                "value":"ORA_ACTIVE"
            }
        ]
    },
    "offset":0,
    "limit":20,
    "sort":[
        {
            "attribute":"CreationDate",
            "direction":"descending"
        }
    ]
}
Nested Schema : q
Type: object
Query criteria for filtering results.
Show Source
Nested Schema : sort
Type: array
sorting attribute and direction of sort.
Show Source
Nested Schema : criteria
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "CreationDate", "LastUpdateDate" ]
    Attribute to sort the results.
  • Allowed Values: [ "ascending", "descending" ]
    Direction of sorting.
Back to Top

Response

Supported Media Types

200 Response

Successful response
Body ()
Root Schema : subscriptionProductSearchResponse
Type: object
Show Source
Nested Schema : items
Type: array
The items in the collection.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : SubscriptionId
Type: object
Show Source
Example Response (totalResults)
8
Example Response (offset)
0
Example Response (count)
8
Example Response (hasMore)
false
Example Response (limit)
20
Example Response (links)
[
    {
        "rel":"self",
        "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/actions/search"
    }
]
Example Response (items)
[
    {
        "PONumber":null,
        "CreationDate":"2025-10-22T08:55:17.919+0000",
        "MonthlyRecurringRevenue":"200",
        "SalesProductType":"SUBSCRIPTION",
        "ProductName":"New_Command_Center_Subs",
        "TcvWithTotalUsageCharge":null,
        "SalesProductType_localizedValue":"Subscription",
        "BillingFrequency_localizedValue":"MONTH",
        "RenewalType_localizedValue":"Renew",
        "_entity":"SubscriptionsProduct",
        "ExternalAssetKey":"abo_344d7280-2f28-4010-9591-9bd34b37edfb",
        "StartDate":"2015-01-01T00:00:00.000+0000",
        "SubscriptionId":{
            "SubscriptionNumber":"CDRM_63367"
        },
        "Currency":"USD",
        "SubscriptionProductId":"300100687940732",
        "Status":"ORA_ACTIVE",
        "PendingActivationFlag":null,
        "RenewedDate":null,
        "BillingFrequency":"0zG",
        "TotalContractValue":"26500",
        "Status_localizedValue":"Active",
        "SubscriptionProductPuid":"300100687938861",
        "ExternalParentAssetKey":null,
        "Quantity":1,
        "RenewalType":"RENEW",
        "EndDate":"2025-12-31T00:00:00.000+0000",
        "ExternalRootAssetKey":"abo_344d7280-2f28-4010-9591-9bd34b37edfb",
        "BillToAccountId":1006,
        "PaymentMethod_localizedValue":null,
        "PaymentMethod":null,
        "InvoicedAmount":null,
        "Currency_localizedValue":"US Dollar",
        "LastUpdateDate":"2025-10-22T08:55:21.387+0000"
    },
    {
        "PONumber":null,
        "CreationDate":"2025-10-22T08:55:13.958+0000",
        "MonthlyRecurringRevenue":"2000",
        "SalesProductType":"SUBSCRIPTION",
        "ProductName":"New_Command_Center_Subs",
        "TcvWithTotalUsageCharge":null,
        "SalesProductType_localizedValue":"Subscription",
        "BillingFrequency_localizedValue":"MONTH",
        "RenewalType_localizedValue":"Renew",
        "_entity":"SubscriptionsProduct",
        "ExternalAssetKey":"abo_d978c060-fbe2-481f-8b02-88707870b60f",
        "StartDate":"2015-01-01T00:00:00.000+0000",
        "SubscriptionId":{
            "SubscriptionNumber":"CDRM_63367"
        },
        "Currency":"USD",
        "SubscriptionProductId":"300100687940729",
        "Status":"ORA_ACTIVE",
        "PendingActivationFlag":null,
        "RenewedDate":null,
        "BillingFrequency":"0zG",
        "TotalContractValue":"264000",
        "Status_localizedValue":"Active",
        "SubscriptionProductPuid":"300100687938855",
        "ExternalParentAssetKey":null,
        "Quantity":1,
        "RenewalType":"RENEW",
        "EndDate":"2025-12-31T00:00:00.000+0000",
        "ExternalRootAssetKey":"abo_d978c060-fbe2-481f-8b02-88707870b60f",
        "BillToAccountId":1006,
        "PaymentMethod_localizedValue":null,
        "PaymentMethod":null,
        "InvoicedAmount":null,
        "Currency_localizedValue":"US Dollar",
        "LastUpdateDate":"2025-10-22T08:55:21.221+0000"
    },
    {
        "PONumber":null,
        "CreationDate":"2025-10-22T08:55:10.046+0000",
        "MonthlyRecurringRevenue":"250",
        "SalesProductType":"SUBSCRIPTION",
        "ProductName":"New_Command_Center_Subs",
        "TcvWithTotalUsageCharge":null,
        "SalesProductType_localizedValue":"Subscription",
        "BillingFrequency_localizedValue":"MONTH",
        "RenewalType_localizedValue":"Renew",
        "_entity":"SubscriptionsProduct",
        "ExternalAssetKey":"abo_a64b63ab-cfd2-45eb-8981-daaf552dd0fd",
        "StartDate":"2015-01-01T00:00:00.000+0000",
        "SubscriptionId":{
            "SubscriptionNumber":"CDRM_63367"
        },
        "Currency":"USD",
        "SubscriptionProductId":"300100687940725",
        "Status":"ORA_ACTIVE",
        "PendingActivationFlag":null,
        "RenewedDate":null,
        "BillingFrequency":"0zG",
        "TotalContractValue":"33100",
        "Status_localizedValue":"Active",
        "SubscriptionProductPuid":"300100687938846",
        "ExternalParentAssetKey":null,
        "Quantity":1,
        "RenewalType":"RENEW",
        "EndDate":"2025-12-31T00:00:00.000+0000",
        "ExternalRootAssetKey":"abo_a64b63ab-cfd2-45eb-8981-daaf552dd0fd",
        "BillToAccountId":1006,
        "PaymentMethod_localizedValue":null,
        "PaymentMethod":null,
        "InvoicedAmount":null,
        "Currency_localizedValue":"US Dollar",
        "LastUpdateDate":"2025-10-22T08:55:21.221+0000"
    },
    {
        "PONumber":null,
        "CreationDate":"2025-10-22T08:55:05.431+0000",
        "MonthlyRecurringRevenue":"200",
        "SalesProductType":"SUBSCRIPTION",
        "ProductName":"New_Command_Center_Subs",
        "TcvWithTotalUsageCharge":null,
        "SalesProductType_localizedValue":"Subscription",
        "BillingFrequency_localizedValue":"MONTH",
        "RenewalType_localizedValue":"Renew",
        "_entity":"SubscriptionsProduct",
        "ExternalAssetKey":"abo_b3f3507b-779d-4fcf-8af6-b61c0169f7ad",
        "StartDate":"2015-01-01T00:00:00.000+0000",
        "SubscriptionId":{
            "SubscriptionNumber":"CDRM_63367"
        },
        "Currency":"USD",
        "SubscriptionProductId":"300100687940721",
        "Status":"ORA_ACTIVE",
        "PendingActivationFlag":null,
        "RenewedDate":null,
        "BillingFrequency":"0zG",
        "TotalContractValue":"26500",
        "Status_localizedValue":"Active",
        "SubscriptionProductPuid":"300100687938837",
        "ExternalParentAssetKey":null,
        "Quantity":1,
        "RenewalType":"RENEW",
        "EndDate":"2025-12-31T00:00:00.000+0000",
        "ExternalRootAssetKey":"abo_b3f3507b-779d-4fcf-8af6-b61c0169f7ad",
        "BillToAccountId":1006,
        "PaymentMethod_localizedValue":null,
        "PaymentMethod":null,
        "InvoicedAmount":null,
        "Currency_localizedValue":"US Dollar",
        "LastUpdateDate":"2025-10-22T08:55:21.221+0000"
    },
    {
        "PONumber":null,
        "CreationDate":"2025-10-22T08:53:56.000+0000",
        "MonthlyRecurringRevenue":null,
        "SalesProductType":"SUBSCRIPTION",
        "ProductName":"New_Command_Center_Subs",
        "TcvWithTotalUsageCharge":null,
        "SalesProductType_localizedValue":"Subscription",
        "BillingFrequency_localizedValue":"MONTH",
        "RenewalType_localizedValue":"Renew",
        "_entity":"SubscriptionsProduct",
        "ExternalAssetKey":"abo_344d7280-2f28-4010-9591-9bd34b37edfb",
        "StartDate":"2015-01-01T00:00:00.000+0000",
        "SubscriptionId":{
            "SubscriptionNumber":"CDRM_63367"
        },
        "Currency":"USD",
        "SubscriptionProductId":"300100687940685",
        "Status":"ORA_DRAFT",
        "PendingActivationFlag":"Y",
        "RenewedDate":null,
        "BillingFrequency":"0zG",
        "TotalContractValue":null,
        "Status_localizedValue":"Draft",
        "SubscriptionProductPuid":"CDRM_63367-PRDT-59990",
        "ExternalParentAssetKey":"",
        "Quantity":1,
        "RenewalType":"RENEW",
        "EndDate":"2025-12-31T00:00:00.000+0000",
        "ExternalRootAssetKey":"abo_344d7280-2f28-4010-9591-9bd34b37edfb",
        "BillToAccountId":1006,
        "PaymentMethod_localizedValue":null,
        "PaymentMethod":null,
        "InvoicedAmount":null,
        "Currency_localizedValue":"US Dollar",
        "LastUpdateDate":"2025-10-22T08:54:01.043+0000"
    },
    {
        "PONumber":null,
        "CreationDate":"2025-10-22T08:53:53.000+0000",
        "MonthlyRecurringRevenue":null,
        "SalesProductType":"SUBSCRIPTION",
        "ProductName":"New_Command_Center_Subs",
        "TcvWithTotalUsageCharge":null,
        "SalesProductType_localizedValue":"Subscription",
        "BillingFrequency_localizedValue":"MONTH",
        "RenewalType_localizedValue":"Renew",
        "_entity":"SubscriptionsProduct",
        "ExternalAssetKey":"abo_d978c060-fbe2-481f-8b02-88707870b60f",
        "StartDate":"2015-01-01T00:00:00.000+0000",
        "SubscriptionId":{
            "SubscriptionNumber":"CDRM_63367"
        },
        "Currency":"USD",
        "SubscriptionProductId":"300100687940680",
        "Status":"ORA_DRAFT",
        "PendingActivationFlag":"Y",
        "RenewedDate":null,
        "BillingFrequency":"0zG",
        "TotalContractValue":null,
        "Status_localizedValue":"Draft",
        "SubscriptionProductPuid":"CDRM_63367-PRDT-59989",
        "ExternalParentAssetKey":"",
        "Quantity":1,
        "RenewalType":"RENEW",
        "EndDate":"2025-12-31T00:00:00.000+0000",
        "ExternalRootAssetKey":"abo_d978c060-fbe2-481f-8b02-88707870b60f",
        "BillToAccountId":1006,
        "PaymentMethod_localizedValue":null,
        "PaymentMethod":null,
        "InvoicedAmount":null,
        "Currency_localizedValue":"US Dollar",
        "LastUpdateDate":"2025-10-22T08:53:55.026+0000"
    },
    {
        "PONumber":null,
        "CreationDate":"2025-10-22T08:53:50.000+0000",
        "MonthlyRecurringRevenue":null,
        "SalesProductType":"SUBSCRIPTION",
        "ProductName":"New_Command_Center_Subs",
        "TcvWithTotalUsageCharge":null,
        "SalesProductType_localizedValue":"Subscription",
        "BillingFrequency_localizedValue":"MONTH",
        "RenewalType_localizedValue":"Renew",
        "_entity":"SubscriptionsProduct",
        "ExternalAssetKey":"abo_a64b63ab-cfd2-45eb-8981-daaf552dd0fd",
        "StartDate":"2015-01-01T00:00:00.000+0000",
        "SubscriptionId":{
            "SubscriptionNumber":"CDRM_63367"
        },
        "Currency":"USD",
        "SubscriptionProductId":"300100687943198",
        "Status":"ORA_DRAFT",
        "PendingActivationFlag":"Y",
        "RenewedDate":null,
        "BillingFrequency":"0zG",
        "TotalContractValue":null,
        "Status_localizedValue":"Draft",
        "SubscriptionProductPuid":"CDRM_63367-PRDT-59988",
        "ExternalParentAssetKey":"",
        "Quantity":1,
        "RenewalType":"RENEW",
        "EndDate":"2025-12-31T00:00:00.000+0000",
        "ExternalRootAssetKey":"abo_a64b63ab-cfd2-45eb-8981-daaf552dd0fd",
        "BillToAccountId":1006,
        "PaymentMethod_localizedValue":null,
        "PaymentMethod":null,
        "InvoicedAmount":null,
        "Currency_localizedValue":"US Dollar",
        "LastUpdateDate":"2025-10-22T08:53:52.036+0000"
    },
    {
        "PONumber":null,
        "CreationDate":"2025-10-22T08:53:47.000+0000",
        "MonthlyRecurringRevenue":null,
        "SalesProductType":"SUBSCRIPTION",
        "ProductName":"New_Command_Center_Subs",
        "TcvWithTotalUsageCharge":null,
        "SalesProductType_localizedValue":"Subscription",
        "BillingFrequency_localizedValue":"MONTH",
        "RenewalType_localizedValue":"Renew",
        "_entity":"SubscriptionsProduct",
        "ExternalAssetKey":"abo_b3f3507b-779d-4fcf-8af6-b61c0169f7ad",
        "StartDate":"2015-01-01T00:00:00.000+0000",
        "SubscriptionId":{
            "SubscriptionNumber":"CDRM_63367"
        },
        "Currency":"USD",
        "SubscriptionProductId":"300100687936223",
        "Status":"ORA_DRAFT",
        "PendingActivationFlag":"Y",
        "RenewedDate":null,
        "BillingFrequency":"0zG",
        "TotalContractValue":null,
        "Status_localizedValue":"Draft",
        "SubscriptionProductPuid":"CDRM_63367-PRDT-59987",
        "ExternalParentAssetKey":"",
        "Quantity":1,
        "RenewalType":"RENEW",
        "EndDate":"2025-12-31T00:00:00.000+0000",
        "ExternalRootAssetKey":"abo_b3f3507b-779d-4fcf-8af6-b61c0169f7ad",
        "BillToAccountId":1006,
        "PaymentMethod_localizedValue":null,
        "PaymentMethod":null,
        "InvoicedAmount":null,
        "Currency_localizedValue":"US Dollar",
        "LastUpdateDate":"2025-10-22T08:53:49.033+0000"
    }
]

400 Response

Bad request
Body ()
Root Schema : Error
Type: object
Show Source

500 Response

Internal server error
Body ()
Root Schema : Error
Type: object
Show Source
Back to Top