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

Get Distributor Subscription Transactions

Description

Retrieves details about the transactions of a specified subscription within a specified Distributor organization.

Request

Request

URL

URL


get
https://{api_host}/distributors/{orgId}/subscriptions/{subscriptionId}/transactions
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


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DistributorTransaction of type application/json
{
	"customerRef": {
		"name": "San Diego University",
		"uuid": "ohgf678-456ygvb-56tg"
	},
	"organizationRef": {
		"id": "San Diego University",
		"name": "ohgf678-456ygvb-56tg"
	},
	"resellerRef": {
		"name": "San Diego University",
		"orgId": "234dfghj-345dfghj-56g",
		"partnerId": "112341234"
	},
	"serviceRefs": [
		{
			"id": "1234-1234-1234-123123",
			"name": "Workspace ONE Standard",
			"serviceIcon": "https://www.workspace.com/service_icon"
		}
	],
	"transactions": [
		{
			"billingEngineOrderId": "1325678",
			"currency": "USD",
			"id": "ff1a8d82-1b1d-4bd2-8d83-cb1365f375c4",
			"offerGroups": [
				{
					"adPlus": "5",
					"billingFrequency": "PREPAID",
					"billingTerm": 12,
					"billingTermUom": "MONTHS",
					"channel": "5",
					"creationDate": "2020-04-05T00:05:01.194Z",
					"currency": "USD",
					"customerSegment": "ACADEMIC",
					"description": "Bundle Offer details",
					"discountSavings": [
						{
							"discountAmount": "500",
							"type": "RCD"
						}
					],
					"endDate": "2021-04-07T00:05:01.194Z",
					"id": "string",
					"listPrice": "9500",
					"name": "Bundle Offer",
					"netPrice": "7800",
					"offerCategory": "PRIMARY",
					"offerCost": {
						"cNetPrice": 42,
						"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",
							"crossRefSku": "COS-XASD-999",
							"currency": "USD",
							"description": "Production Support/Subscription",
							"endDate": "2023-09-15T06:07:50.000Z",
							"hostingType": "SHARED",
							"licenseUnit": "SERVER",
							"name": "VMware Workspace ONE Standard",
							"offerCategory": "PRIMARY",
							"offerConfigGroupId": "OG09876DF",
							"offerCost": {
								"cNetPrice": 42,
								"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"
							},
							"startDate": "2022-09-15T06:07:51.000Z",
							"status": "SUBMITTED",
							"supportLevel": "PRODUCTIONSUPPORT",
							"usageItems": [
								{
									"chargeId": "CHID",
									"chargeType": "TYPE",
									"crossRefSku": "COS-XASD-999",
									"currency": "USD",
									"description": "string",
									"name": "Dummy",
									"offerCost": {
										"cNetPrice": 42,
										"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,
									"tierName": "1T",
									"uom": "DEVICE"
								}
							]
						}
					],
					"productId": "OG-HOST",
					"programOption": "string",
					"purchaseQuantity": 0,
					"routeToMarket": "string",
					"startDate": "2020-04-07T00:05:01.194Z",
					"supportLevel": "string",
					"term": "9",
					"tierName": "T5",
					"totalDiscount": "19",
					"unitListPrice": "95",
					"unitNetPrice": "78",
					"uom": "HOST",
					"volumeTierDiscount": "5"
				}
			],
			"offers": [
				{
					"billingFrequency": "PREPAID",
					"billingModel": "COMMIT_REQUIRED",
					"crossRefSku": "string",
					"currency": "USD",
					"description": "string",
					"discountSavings": [
						{
							"attributes": {},
							"discountAmount": 0,
							"type": "RCD"
						}
					],
					"endDate": "2021-08-12T09:44:58Z",
					"licenseUnit": "string",
					"name": "string",
					"offerCategory": "PRIMARY",
					"offerCost": {
						"cNetPrice": 42,
						"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",
					"programOption": "string",
					"purchaseQuantity": 0,
					"quantityUom": "string",
					"referenceId": "string",
					"startDate": "2021-08-11T09:44:58Z",
					"status": "SUBMITTED",
					"tierName": "tier name",
					"usageItems": [
						{
							"chargeId": "1234",
							"chargeType": "type",
							"currency": "USD",
							"description": "Usage Item",
							"name": "usage",
							"offerCost": {
								"cNetPrice": 42,
								"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_ADV_TS",
							"purchaseQuantity": 1,
							"tierName": "string",
							"uom": "unit"
						}
					],
					"usageSubmissionModel": "string"
				}
			],
			"quoteId": "112233445566778899",
			"requester": "San Diego",
			"resellerRef": {
				"name": "San Diego University",
				"orgId": "234dfghj-345dfghj-56g",
				"partnerId": "112341234"
			},
			"totalNetPrice": 1,
			"transactionDate": "2021-08-12T09:44:58Z",
			"transactionType": "INITIAL"
		}
	]
}
customerRef Optional

Reference object containing minimal details of a customer


organizationRef Optional

Reference object containing minimal details of organization.


resellerRef Optional

Reference object containing minimal details of a reseller


array of ServiceRef
serviceRefs Optional

List of services in the subscription


transactions Optional

List of transactions done on this 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://{api_host}/distributors/{orgId}/subscriptions/{subscriptionId}/transactions


Feedback

Was this page helpful?