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

Post Subscription History By Subscription ID

Description

Retrieves the history of a specified subscription.

Request

Request

URL

URL


post
https://{api_host}/orgs/{orgId}/subscriptions/{subscriptionId}/history
Copy

Path Parameters

Path Parameters

string
orgId Required

  • ID of the MSP organization in CSP.


string
subscriptionId Required

  • ID of the subscription in an organization.


Query Parameters

Query Parameters

integer
page_limit Optional

  • Maximum number to return in response. Defaults to 100


integer
page_start Optional

  • Start index of records to fetch. Defaults to 1


Request Body

Request Body

SubscriptionHistorySearchRequest of mimetype application/json Optional

Payload that retrieves the history of a specified subscription.

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

The consolidated list of objects ‘SubscriptionHistoryFilter’ ‘SubscriptionHistoryBetweenFilter’ ‘SubscriptionHistoryMatchingFilter’.


sorter Optional

Defines the properties of the Subscription history sorter.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SubscriptionHistoryPage of type application/json
{
	"current": 1,
	"next": 3,
	"results": [
		{
			"createTransaction": {
				"offers": [
					{
						"billingFrequency": "MONTHLY",
						"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
					}
				],
				"totalListPrice": 35532.2
			},
			"offerStatusTransaction": {
				"offers": [
					{
						"changeReasons": [
							{
								"code": "TERM_OVER",
								"message": "example message"
							}
						],
						"fromStatus": "ACTIVE",
						"offerRef": {
							"description": "WSO Advanced",
							"name": "VMware Workspace ONE Standard",
							"referenceId": "215acdc7-d01b-4b16-a3e4-99b9085aa3ec"
						},
						"toStatus": "EXPIRED"
					}
				]
			},
			"renewalPreferenceTransaction": {
				"fromPreference": "AUTO",
				"toPreference": "MANUAL"
			},
			"requestor": {
				"email": "abc@example.com",
				"entityType": "USER",
				"firstName": "Amy",
				"lastName": "FarrahFowler"
			},
			"subscriptionDateChangeTransaction": {
				"changeReasons": [
					{
						"code": "RENEWAL",
						"message": "example message"
					}
				],
				"fromSubscriptionEndDateTime": "2020-12-22T00:00:00Z",
				"toSubscriptionEndDateTime": "2021-12-22T00:00:00Z"
			},
			"subscriptionOfferAmendTransaction": {
				"offers": [
					{
						"billingFrequency": "MONTHLY",
						"billingTerm": 1,
						"chargeId": "VOD-DBC-01",
						"crossRefSku": "COS-XASD-999",
						"description": "Production Support/Subscription",
						"exchangeOffers": [
							{
								"description": "WSO Advanced",
								"name": "VMware Workspace ONE Standard",
								"referenceId": "215acdc7-d01b-4b16-a3e4-99b9085aa3ec"
							}
						],
						"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
					}
				]
			},
			"subscriptionStatusChangeTransaction": {
				"changeReasons": [
					{
						"code": "NO_RENEWAL",
						"message": "example code"
					}
				],
				"fromStatus": "ACTIVE",
				"toStatus": "EXPIRED"
			},
			"transactionDate": "2020-12-22T00:00:00Z",
			"transactionType": "INITIAL"
		}
	],
	"totalResultsCount": 100
}
integer as int32
current Optional

The current value of the subscription history page.


integer as int32
next Optional

The next value of the subscription history page.


array of TransactionInfo
results Optional

The list of the transactions.


integer as int32
totalResultsCount Optional

The total count of the subscription history 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":"TRANSACTION_DATE","operator":"ASC"}}' https://{api_host}/orgs/{orgId}/subscriptions/{subscriptionId}/history


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

Was this page helpful?