Get Distributor Subscriptions
DescriptionRetrieves details about all subscriptions of a specified Distributor organization. The subscription list is paginated. Filtration and sorting of the subscription list can be done using appropriate parameters in request body.
- Default Filter: INCLUDE_INACTIVE_SUBSCRIPTIONS (False)
- Default Sorting Order: SUBSCRIPTION_END_DATE (Ascending)
Request
URLURL
Path Parameters
Path Parameters
ID of the partner organization in CSP
Query Parameters
Query Parameters
Number of results to be fetched per page
Result number to be first on the page
Request Body
Distributor subscription summary filters and sorter
{
"filters": [
{
"key": "BILLING_ENGINE_SUBSCRIPTION_ID",
"operator": "EQUALS",
"value": "M0353803413"
},
{
"key": "CUSTOMER_NAME",
"operator": "LIKE",
"value": "Coke Inc"
}
],
"sorter": {
"key": "SUBSCRIPTION_END_DATE",
"operator": "ASC"
}
}
A list of filters for subscription summary list for Distributor
A sorter for subscription summary list for Distributor
Authentication
Response
Response BodyResponse Body
200 OK
{
"current": 1,
"next": 10,
"results": [
{
"billingEngineSubscriptionId": "M13130022",
"customerOrgId": "34dfghjk-9kgfffgf-7ybdcn",
"customerRef": {
"name": "San Diego University"
},
"id": "34563",
"renewalPreference": "NOT_SELECTED",
"resellerRef": {
"name": "Rackspace",
"orgId": "234dfghj-345dfghj-56g",
"partnerId": "112341234"
},
"serviceRefs": [
{
"id": "1234-1234-1234-123123",
"name": "Workspace One",
"serviceIcon": "https://www.workspace.com/service_icon"
}
],
"status": "ACTIVE",
"subscriptionEndDate": "2021-02-26T18:01:08Z"
}
],
"totalResultsCount": 100
}
First result on the current page
First result on the next page
Paginated list of subscription list for Distributor
The total number of results
Errors
Bad Request - The request is either incomplete or incorrect
Unauthorized - The request requires user authentication
Forbidden - User does not have permission for this operation
Not Found - The requested resource does not exist
Internal Server Error - Please contact support
