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

Get Subscription By ID

Description

Retrieves details about a specified subscription.

Request

Request

URL

URL


get
https://{api_host}/orgs/{orgId}/subscriptions/{subscriptionId}
Copy

Path Parameters

Path Parameters

string
orgId Required

  • ID of the MSP organization in CSP.


string
subscriptionId Required

  • ID of the subscription in a MSP organization.


Query Parameters

Query Parameters

boolean
consolidate_offers Optional

  • The Flag for consolidate offer in a MSP organization.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns MspSubscriptionDetails of type application/json
{
	"billingEngineSubscriptionId": "M13130022",
	"billingFrequency": "MONTHLY",
	"currency": "USD",
	"endDate": "2019-03-02T00:05:01.194Z",
	"id": "33628-4637-267384",
	"offers": [
		{
			"billingFrequency": "MONTHLY",
			"billingModel": "COMMIT_OPTIONAL",
			"billingTerm": 1,
			"chargeId": "VOD-DBC-01",
			"crossRefSku": "COS-XASD-999",
			"description": "Production Support/Subscription",
			"hostingType": "SHARED",
			"licenseUnit": "DEVICE",
			"name": "VMware Workspace ONE Standard",
			"offerCategory": "PRIMARY",
			"offerType": "COMMIT",
			"operatingSystem": "Linux",
			"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
			"purchaseQuantity": 100,
			"region": "EMEA",
			"status": "ACTIVE",
			"supportLevel": "Production",
			"totalListPrice": 35532.2
		}
	],
	"organizationRef": {
		"email": "abc@coke.com",
		"name": "San Diego University",
		"orgId": "163739g-63hijgds-63840bn"
	},
	"payment": {
		"contractId": "5463"
	},
	"renewalPreference": "MANUAL",
	"serviceRef": {
		"id": "1234-1234-1234-123123",
		"name": "Workspace One",
		"serviceIcon": "https://www.workspace.com/service_icon"
	},
	"startDate": "2019-03-02T00:05:01.194Z",
	"status": "ACTIVE"
}
map of string
additionalDetails Optional

The addtional details of msp subscriptions.


boolean
amendable Optional

The flag to switch the value of property amendable


string
billingEngineSubscriptionId Optional

The billing engine subscription id in the subscription details.


string
billingFrequency Optional

The billing frequency of msp subscription details.

Possible values are: PREPAIDMONTHLYANNUAL


consolidatedOffers Optional

The list of consolidated offers.


string
currency Optional

The value of currency in an org.


string
endDate Optional

The end date of the subscription.


string
id Optional

The id of the org.


array of BaseOffer
offers Optional

The list of the Base offers.


orgRef Optional

Defines the properties of the Organization Ref.


payment Optional

Defines the properties of the Subscription Payment Details.


string
renewalPreference Optional

The renewal preference of the subscription details.

Possible values are: MANUALAUTOCANCEL


serviceRef Optional

Defines the properties of the Service Ref.


string
startDate Optional

The start date of the subscription.


string
status Optional

The msp subscription details status, the value can be ‘SUBMITTED’ ‘CREATED’ ‘ACTIVE’ etc

Possible values are: SUBMITTEDCREATEDACTIVESUSPENDEDCANCELLEDTERMINATEDERRORPENDING_EXPIRYEXPIRED

Errors

Errors

ErrorResponse
400

Bad Request


ErrorResponse
403

Forbidden


ErrorResponse
404

Not Found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/orgs/{orgId}/subscriptions/{subscriptionId}


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

Was this page helpful?