[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Get Distributor Subscriptions

Description

Retrieves 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

Request

URL

URL


post
https://{api_host}/distributors/{orgId}/subscriptions/search
Copy

Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP


Query Parameters

Query Parameters

integer
pageLimit Optional

Number of results to be fetched per page


integer
pageStart Optional

Result number to be first on the page


Request Body

Request Body

DistributorSubscriptionRequest of mimetype application/json Optional

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"
	}
}
array of object
filters Optional

A list of filters for subscription summary list for Distributor


sorter Optional

A sorter for subscription summary list for Distributor

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DistributorSubscriptionPage of type application/json
{
	"current": 1,
	"next": 10,
	"results": [
		{
			"billingEngineSubscriptionId": "M13130022",
			"customerOrgId": "34dfghjk-9kgfffgf-7ybdcn",
			"customerRef": {
				"name": "San Diego University",
				"uuid": "134-1234-1234-1234"
			},
			"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
}
integer as int32
current Optional

First result on the current page


integer as int32
next Optional

First result on the next page


results Optional

Paginated list of subscription list for Distributor


integer as int32
totalResultsCount Optional

The total number of results

Errors

Errors

ErrorResponse
400

Bad Request - The request is either incomplete or incorrect


ErrorResponse
401

Unauthorized - The request requires user authentication


ErrorResponse
403

Forbidden - User does not have permission for this operation


ErrorResponse
404

Not Found - The requested resource does not exist


ErrorResponse
500

Internal Server Error - Please contact support

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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"}}' https://{api_host}/distributors/{orgId}/subscriptions/search


Feedback

Was this page helpful?