VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Cloud Partner Navigator API Channel Partner Distributors Lifecycle Management

Get Distributor Subscription Details

Description

Retrieves details about a specified subscription within a specified Distributor organization.

Request

Request

URL

URL

get
https://console.navigator.vmware.com/cphub/api/seller/v1/distributors/{orgId}/subscriptions/{subscriptionId}
Copy
Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP
string
subscriptionId Required

ID of a given subscription in CSP

Query Parameters

Query Parameters

boolean
consolidateOffers Optional

Whether or not to fetch consolidated offers of a subscription

Authentication

Authentication

This operation uses the following authentication methods.

csp-auth-token

Response

Response

Response Body

Response Body

200 OK

Returns DistributorSubscriptionDetails of type application/json 
{
	"billingEngineSubscriptionId": "M13130022",
	"currency": "USD",
	"customerRef": {
		"name": "San Diego University"
	},
	"endDate": "2021-02-26T18:01:08Z",
	"id": "33628-4637-267384",
	"offerGroup": {
		"billingFrequency": "PREPAID",
		"billingTerm": 12,
		"billingTermUom": "MONTHS",
		"currency": "USD",
		"description": "Bundle Offer details",
		"endDate": "2021-04-07T00:05:01.194Z",
		"id": "string",
		"name": "Bundle Offer",
		"offerCategory": "PRIMARY",
		"offerCost": {
			"creditSavings": [
				{
					"creditAmount": -1.5,
					"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
					"type": "FLEX_EXCHANGE"
				}
			],
			"discountSavings": [
				{
					"attributes": {
						"property1": "string",
						"property2": "string"
					},
					"discountAmount": -1.5,
					"type": "RCD"
				}
			],
			"totalCreditSavings": -1.63,
			"totalDiscountSavings": -10,
			"totalListPrice": 586.32,
			"totalNetPrice": 421.68,
			"unitListPrice": 42,
			"unitNetPrice": 31
		},
		"offerSubCategory": "CONFIG_BUNDLE",
		"offerType": "COMMIT",
		"offers": [
			{
				"billingFrequency": "PREPAID",
				"billingModel": "COMMIT_REQUIRED",
				"billingTerm": 0,
				"chargeId": "string",
				"currency": "USD",
				"description": "Production Support/Subscription",
				"endDate": "2023-09-15T06:07:50.000Z",
				"hostingType": "SHARED",
				"licenseUnit": "SERVER",
				"name": "VMware Workspace ONE Standard",
				"offerCategory": "PRIMARY",
				"offerCost": {
					"creditSavings": [
						{
							"creditAmount": -1.5,
							"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
							"type": "FLEX_EXCHANGE"
						}
					],
					"discountSavings": [
						{
							"attributes": {
								"property1": "string",
								"property2": "string"
							},
							"discountAmount": -1.5,
							"type": "RCD"
						}
					],
					"totalCreditSavings": -1.63,
					"totalDiscountSavings": -10,
					"totalListPrice": 586.32,
					"totalNetPrice": 421.68,
					"unitListPrice": 42,
					"unitNetPrice": 31
				},
				"offerType": "ONDEMAND",
				"productId": "WSO_CR_STD_TS",
				"purchaseQuantity": 1000,
				"referenceId": "336ecf78-ef0b-4383-9b2f-d4bb1fa1e3fa",
				"region": "NA",
				"serviceRef": {
					"id": "3f2e0417-0ad6-481d-b221-686437701b0e",
					"name": "Workspace ONE",
					"serviceIcon": "http://d2oh183cm2fzuo.cloudfront.net/WS1-Icon.svg"
				},
				"sku": "COS-XASD-999",
				"startDate": "2022-09-15T06:07:51.000Z",
				"status": "SUBMITTED",
				"supportLevel": "PRODUCTIONSUPPORT",
				"usageItems": [
					{
						"chargeId": "CHID",
						"chargeType": "TYPE",
						"currency": "USD",
						"description": "string",
						"name": "Dummy",
						"offerCost": {
							"creditSavings": [
								{
									"creditAmount": -1.5,
									"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
									"type": "FLEX_EXCHANGE"
								}
							],
							"discountSavings": [
								{
									"attributes": {
										"property1": "string",
										"property2": "string"
									},
									"discountAmount": -1.5,
									"type": "RCD"
								}
							],
							"totalCreditSavings": -1.63,
							"totalDiscountSavings": -10,
							"totalListPrice": 586.32,
							"totalNetPrice": 421.68,
							"unitListPrice": 42,
							"unitNetPrice": 31
						},
						"productId": "WSO_CR_STD_TS",
						"purchaseQuantity": 1000,
						"sku": "COS-XASD-999",
						"tierName": "1T",
						"uom": "DEVICE"
					}
				]
			}
		],
		"productId": "OG-HOST",
		"purchaseQuantity": 0,
		"quantityUom": "HOST",
		"routeToMarket": "string",
		"sku": "CFG-BDL-09",
		"startDate": "2020-04-07T00:05:01.194Z",
		"status": "SUBMITTED"
	},
	"offers": [
		{
			"billingTerm": 1,
			"chargeId": "VOD-DBC-01",
			"description": "Production Support/Subscription",
			"hostingType": "SHARED",
			"licenseUnit": "DEVICE",
			"name": "VMware Workspace ONE Standard",
			"offerCategory": "PRIMARY",
			"offerCost": {
				"creditSavings": [],
				"discountSavings": [
					{
						"attributes": {
							"discountPercent": "5.00"
						},
						"discountAmount": -82,
						"type": "RCD"
					}
				],
				"totalCreditSavings": -1.63,
				"totalDiscountSavings": -82,
				"totalListPrice": 586.32,
				"totalNetPrice": 421.68
			},
			"offerType": "COMMIT",
			"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
			"purchaseQuantity": 100,
			"region": "EMEA",
			"sku": "COS-XASD-999",
			"status": "ACTIVE",
			"supportLevel": "Production",
			"usageItems": [
				{
					"chargeId": "TMO_PPS",
					"name": "TMO_PPS",
					"offerCost": {
						"discountSavings": [
							{
								"attributes": {
									"discountPercent": "10"
								},
								"discountAmount": -50,
								"type": "RCD"
							}
						],
						"unitListPrice": 5.2,
						"unitNetPrice": 5.3
					},
					"uom": "PPS"
				}
			]
		},
		{
			"billingTerm": 1,
			"chargeId": "VOD-DBC-01",
			"description": "Production Support/Subscription",
			"hostingType": "SHARED",
			"licenseUnit": "DEVICE",
			"name": "VMware Workspace ONE Boxer",
			"offerCategory": "PRIMARY",
			"offerType": "COMMIT",
			"productId": "45hgfcv-e66e-4e23-8d81-7a13417073d1",
			"purchaseQuantity": 50,
			"region": "EMEA",
			"sku": "COS-XASD-345",
			"status": "ACTIVE",
			"supportLevel": "Production"
		}
	],
	"organizationRef": {
		"id": "163739g-63hijgds-63840bn",
		"name": "Acme Org"
	},
	"paymentType": "FUND",
	"renewalPreference": "MANUAL",
	"resellerRef": {
		"name": "Soft Choice",
		"orgId": "234-134-1234-12334",
		"partnerId": "112341234"
	},
	"serviceRefs": [
		{
			"id": "1234-1234-1234-123123",
			"name": "Workspace One",
			"serviceIcon": "https://www.workspace.com/service_icon"
		}
	],
	"startDate": "2021-02-26T18:01:08Z",
	"totalListPrice": "10300.89",
	"totalNetPrice": 8000.12
}
boolean
amendable Optional

flag to indicate if the subscription is amendable
string
billingEngineDiscountContractId Optional

attribute to indicate billing engine discount contractId.
string
billingEngineSubscriptionId Optional

The underlying billing engine subscription ID
string
billingFrequency Optional

Billing frequency of the offer

Possible values are: PREPAID , MONTHLY , ANNUAL

array of CreateOfferRequest
consolidatedOffers Optional

List of consolidated offers coming under the subscription
string
currency Optional

ISO Currency 3 letter code for subscription currency
CustomerRef
customerRef Optional

Reference object containing minimal details of a customer
string
discountContractId Optional

attribute to indicate discount contractId.
string
endDate Optional

End Date of the Subscription
string
id Optional

Subscription ID coming from CSP
boolean
multiplePartnersTransacted Optional

attribute to indicate the subscription is transacted by multiple partners.
array of OfferGroup
offerGroups Optional

List of all offer groups coming under the subscription
array of Offer
offers Optional

List of all offers coming under the subscription
OrderSource
orderSource Optional

Response Model for Subscription Order Source
OrganizationRef
organizationRef Optional

Reference object containing minimal details of organization.
string
paymentType Optional

Type of payment method used for purchase

Possible values are: FUND , CREDIT_CARD , COMMIT_CONTRACT , PAY_BY_INVOICE_ACCOUNT , COMMIT_AGGREGATE

string
renewalPreference Optional

Renewal preference of a subscription

Possible values are: MANUAL , AUTO , CANCEL , NOT_SELECTED

ResellerRef
resellerRef Optional

Reference object containing minimal details of a reseller
array of ServiceRef
serviceRefs Optional

Minimal Details of the services activated under the Subscription
string
startDate Optional

Start Date of the Subscription
string
status Optional

Current Status of a subscription

Possible values are: SUBMITTED , CREATED , ACTIVE , SUSPENDED , CANCELLED , TERMINATED , ERROR , PENDING_EXPIRY , EXPIRED

string
subscriptionType Optional

Type of subscription. Could be COMMIT/ONDEMAND

Possible values are: COMMIT , ONDEMAND

string
totalListPrice Optional

The total list price (MSRP) at this grouping level. (in offers this same as unit but for subscription this is defined as purchaseQuantity * unitListPrice)
number as double
totalNetPrice Optional

totalNetAmount = totalSalePrice+totalPromotionSavings+totalCreditSavings+totalTaxes. The sum of the total net amount at this grouping level
number as double
totalRenewalNetPrice Optional

Total Renewal Net Price for the subscription
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 https://console.navigator.vmware.com/cphub/api/seller/v1/distributors/{orgId}/subscriptions/{subscriptionId}

Generated on: 26 May 23 05:43 UTC
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
On This Page
Distributors Operations
post
Download Reseller Discount Contracts
post
Download Reseller Redemptions
get
Get Reseller Discount Contract Customers
get
Get Reseller Discount Contract Details
post
Get Reseller Discount Contracts
post
Get Reseller Redemptions
get
Get Reseller Subscription Details
get
Get Reseller Subscription Transactions
post
Get Reseller Subscriptions
post
Get Reseller Transactions
Feedback

Was this page helpful?

© 2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us