Listing subscription products
post
/ccstore/v1/selfservice/subscriptionProducts/search
Lists the subscription products across subscriptions
Request
Supported Media Types
- application/json
Request payload to list subscription products
Root Schema : subscriptionProductSearchRequest
Type:
Show Source
object-
limit:
integer
Number of records to return.
-
offset:
integer
Offset for pagination.
-
q:
object q
Query criteria for filtering results.
-
sort:
array sort
sorting attribute and direction of sort.
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 : items
Type:
Show Source
object-
attribute:
string
Attribute to filter Results(e.g Status, SubscriptionId.SubscriptionNumber).
-
op:
string
Comparison operator (e.g., $eq, $gt, $in, $lt).
-
value:
string
Attribute value to match.
Nested Schema : items
Type:
Show Source
object-
attribute:
string
Allowed Values:
[ "CreationDate", "LastUpdateDate" ]Attribute to sort the results. -
direction:
string
Allowed Values:
[ "ascending", "descending" ]Direction of sorting.
Response
Supported Media Types
- application/json
200 Response
Successful response
Root Schema : subscriptionProductSearchResponse
Type:
Show Source
object-
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
The items in the collection.
-
limit:
integer
The actual paging size used by the server.
-
links:
array links
-
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.
Nested Schema : items
Type:
Show Source
object-
_entity:
string
The requested entity like SubscriptionsProduct
-
BillingFrequency:
string
The billing frequency.
-
BillToAccountId:
string
The billing account Id for the product.
-
Currency:
string
The currency associated with the subscription product.
-
EndDate:
string(date)
The date when the subscriptions starts.
-
ExternalAssetKey:
string
The external asset key of the subscription product.
-
ExternalParentAssetKey:
string
The external parent asset key of the subscription product.
-
MonthlyRecurringRevenue:
string
The monthly recurring revenue of the product.
-
PaymentMethod:
string
The payment type of the subscription product
-
Quantity:
number
The quantity of the product.
-
RenewalType:
string
The renewal type for the subscription product.
-
RenewedDate:
string(date)
The date when the subscriptions renewed.
-
SalesProductType:
string
The type of the sales product.
-
StartDate:
string(date)
The date when the subscriptions starts.
-
Status:
string
Allowed Values:
[ "ORA_ACTIVE", "ORA_UNDER_AMENDMENT", "ORA_DRAFT", "ORA_CLOSED", "ORA_EXPIRED", "ORA_SUSPENDED" ]The current status of the subscription product. -
SubscriptionId:
object SubscriptionId
-
SubscriptionProductId:
string
The public unique identifier of the subscription product.
-
TcvWithTotalUsageCharge:
string
The value of the total contract.
Nested Schema : SubscriptionId
Type:
Show Source
object-
SubscriptionNumber:
string
The subscription number of the product.
Nested Schema : Link
Type:
Show Source
object-
href:
string
The hyperlink reference
-
rel:
string
The relation of the link
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
Root Schema : Error
Type:
Show Source
object-
message:
string
The error message
-
status:
string
The Error code
500 Response
Internal server error
Root Schema : Error
Type:
Show Source
object-
message:
string
The error message
-
status:
string
The Error code