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

Get All Subscriptions

Description

Retrieves all subscription summaries of a specified provider organization.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
orgId Required

  • ID of the MSP organization in CSP.


Query Parameters

Query Parameters

integer
page_limit Optional

  • Maximum number of groups to return in response. Defaults to 100


integer
page_start Optional

  • Start index of records to fetch. Defaults to 1


Request Body

Request Body

SubscriptionSearchRequest of mimetype application/json Optional

Payload that retrieves all subscription summaries of a specified provider organization.

{
	"filters": {},
	"sorter": {
		"key": "BILLING_ENGINE_SUBSCRIPTION_ID",
		"operator": "ASC"
	}
}
array of object
filters Optional

The list of object ‘SubscriptionBetweenFilter’, ‘SubscriptionInFilter’ & ‘SubscriptionMatchingFilter’.


sorter Optional

Defines the properties of the Subscription Summary Sorter.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SubscriptionPage of type application/json
{
	"current": 1,
	"next": 3,
	"results": [
		{
			"billingEngineSubscriptionId": "M13130022",
			"id": "abdb210c-3459-4487-b0aa-dc64947b8a13",
			"organizationRef": {
				"id": "",
				"name": "Example Customer",
				"uuid": "1234568d-49c0-49eb-baf3-e5d16cf32d22"
			},
			"renewalPreference": "AUTO",
			"serviceRef": {
				"id": "NdljjyL-H773h81kNjDlanm67ZA_",
				"name": "Workspace ONE",
				"serviceIcon": "http://d2oh183cm2fzuo.cloudfront.net/WS1-Icon.svg"
			},
			"status": "SUBMITTED",
			"subscriptionEndDate": "2020-12-22T00:00:00Z"
		}
	],
	"totalResultsCount": 100
}
integer as int32
current Optional

The value of the current page.


integer as int32
next Optional

The value of the next page.


results Optional

The list of object of Subscription Summary.


integer as int32
totalResultsCount Optional

The total count of the page.

Errors

Errors

ErrorResponse
400

Bad Request


ErrorResponse
403

Forbidden


ErrorResponse
404

Not Found

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"filters":{},"sorter":{"key":"BILLING_ENGINE_SUBSCRIPTION_ID","operator":"ASC"}}' https://{api_host}/orgs/{orgId}/subscriptions/search


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

Was this page helpful?