Get Subscription V3 Using GET
Retrieve a subscription by its ID.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Owner | ✔️ | ✔️ |
| Billing Read-only | ✔️ | ✔️ |
Request
URI
GET
https://{api_host}/csp/gateway/commerce/api/v3/subscriptions/{subscriptionId}
COPY
Path Parameters
string
subscriptionId
Required
subscriptionId
Query Parameters
boolean
expand
Optional
Constraints:
default: true
Expand for including data from underlying billing engine
boolean
includeOverageOffer
Optional
Constraints:
default: false
If true, the overage offer will be included in the response
boolean
includeOfferGroups
Optional
Constraints:
default: false
If true, offer groups will be included in the response
Responses
200
OK
Returns
V3SubscriptionResponse
of type(s)
application/json
{
"billingEngine": "SAP",
"billingEngineSubscriptionId": "M123 or AWS ARN",
"billingModel": "string",
"context": {
"context": "string"
},
"creationDateTime": "2020-04-07T00:05:01.194Z",
"currency": "USD",
"displayBillingEngineSubscriptionId": "string",
"flexExchangeLock": false,
"insights": [
"[BASE, UPGRADE, SUBSCRIPTION_MOBILITY_IN_PROGRESS]"
],
"offerGroups": [
{
"billingFrequency": "PREPAID",
"billingModel": "string",
"billingTerm": 1,
"billingTermUom": "MONTHS",
"chargeId": "VOD-DBC-01",
"configErrors": [
{
"allowedValues": [
"string"
],
"errorCode": "string",
"fieldName": "licenseUnit",
"message": "Blah failed. Orphaned Addon needs to be adjusted",
"referenceId": "cb2425b4-203b-4a2a-8a72-2555aa7d4ec6",
"ruleId": "rule123"
}
],
"customerSegment": "COMMERCIAL",
"description": "vSphere vRCU with Advanced AI-driven cloud storage",
"hideOffers": false,
"name": "vSphere-vRCU",
"offerCategory": "PRIMARY",
"offerConfigGroups": [
{
"allocatedQuantity": 5,
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerRuleValidationReferenceId": "eb660ba4-08d1-49ac-a497-c19cb3c098a9"
}
],
"offerGroupCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"offerGroupCreationDateTime": "2020-04-07T00:05:01.194Z",
"offerGroupEndDateTime": "2020-04-07T00:05:01.194Z",
"offerGroupId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
"offerGroupStartDateTime": "2020-04-07T00:05:01.194Z",
"offerLabels": {
"offerLabels": "string"
},
"offerSubCategory": "CONFIG_BUNDLE",
"offerType": "COMMIT",
"offers": [
{
"additionalAttributes": {},
"billingFrequency": "PREPAID",
"billingModel": "string",
"billingTerm": 1,
"billingTermUom": "MONTHS",
"chargeId": "VOD-DBC-01",
"chargeType": "STANDARD",
"components": [
{
"description": "A long Service Standard Offer description",
"productFamily": "VMC-AWS",
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"quantity": 5
}
],
"configErrors": [
{
"allowedValues": [
"string"
],
"errorCode": "string",
"fieldName": "licenseUnit",
"message": "Blah failed. Orphaned Addon needs to be adjusted",
"referenceId": "cb2425b4-203b-4a2a-8a72-2555aa7d4ec6",
"ruleId": "rule123"
}
],
"customerSegment": "COMMERCIAL",
"dataCenter": "US-WEST1",
"deprovisioning": "string",
"description": "A non localized description of offer",
"exchangeOffers": [
{
"deprovisioning": "string",
"flexExchangeDateTime": "2021-03-02T00:05:01.194Z",
"purchaseQuantity": 10,
"referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
"status": "string",
"type": "string"
}
],
"flexExchangeDateTime": "2021-03-02T00:05:01.194Z",
"hostingType": "SHARED",
"isMandatoryInOfferGroup": false,
"licenseUnit": "DEVICE",
"name": "VMware Cloud on AWS",
"offerCategory": "string",
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerConfigGroups": [
{
"allocatedQuantity": 5,
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerRuleValidationReferenceId": "eb660ba4-08d1-49ac-a497-c19cb3c098a9"
}
],
"offerCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"offerEndDateTime": "2020-04-07T00:05:01.194Z",
"offerGroupMultiplier": 5,
"offerLabels": {
"offerLabels": "string"
},
"offerStartDateTime": "2020-04-07T00:05:01.194Z",
"offerSubCategory": "string",
"offerTimelineGroupId": "704b3943-93bb-4f5e-a3eb-396253cf1808",
"offerType": "COMMIT",
"operatingSystem": "Linux",
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"programOption": "VA21",
"proratedOfferCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"purchaseQuantity": 10,
"referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
"region": "EMEA",
"retentionPeriod": "P2M",
"routeToMarket": "string",
"serviceDefinedAttributes": [
{
"name": "string",
"value": "string"
}
],
"serviceDefinitionId": "8a27ac37-66f1-4a03-be36-dbe55b05f96c",
"status": "string",
"statusChangeDateTime": "2020-04-07T00:05:01.194Z",
"supportLevel": "Basic",
"tierDescription": "string",
"tierName": "T1",
"uom": "HOST",
"uomTimeScale": "HOUR",
"usageItems": [
{
"additionalAttributes": {},
"billingFrequency": "PREPAID",
"billingModel": "string",
"billingTerm": 1,
"billingTermUom": "MONTHS",
"chargeId": "VOD-DBC-01",
"chargeType": "STANDARD",
"components": [
{
"description": "A long Service Standard Offer description",
"productFamily": "VMC-AWS",
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"quantity": 5
}
],
"configErrors": [
{
"allowedValues": [
"string"
],
"errorCode": "string",
"fieldName": "licenseUnit",
"message": "Blah failed. Orphaned Addon needs to be adjusted",
"referenceId": "cb2425b4-203b-4a2a-8a72-2555aa7d4ec6",
"ruleId": "rule123"
}
],
"customerSegment": "COMMERCIAL",
"dataCenter": "US-WEST1",
"description": "A non localized description of offer",
"hostingType": "SHARED",
"isMandatoryInOfferGroup": false,
"licenseUnit": "DEVICE",
"name": "VMware Cloud on AWS",
"offerCategory": "string",
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerConfigGroups": [
{
"allocatedQuantity": 5,
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerRuleValidationReferenceId": "eb660ba4-08d1-49ac-a497-c19cb3c098a9"
}
],
"offerCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"offerGroupMultiplier": 5,
"offerLabels": {
"offerLabels": "string"
},
"offerSubCategory": "string",
"offerTimelineGroupId": "704b3943-93bb-4f5e-a3eb-396253cf1808",
"offerType": "COMMIT",
"operatingSystem": "Linux",
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"programOption": "VA21",
"proratedOfferCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"purchaseQuantity": 10,
"referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
"region": "EMEA",
"retentionPeriod": "P2M",
"routeToMarket": "string",
"serviceDefinedAttributes": [
{
"name": "string",
"value": "string"
}
],
"serviceDefinitionId": "8a27ac37-66f1-4a03-be36-dbe55b05f96c",
"supportLevel": "Basic",
"tierDescription": "string",
"tierName": "T1",
"uom": "HOST",
"uomTimeScale": "HOUR",
"usageSubmissionModel": "string"
}
],
"usageSubmissionModel": "string"
}
],
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"programOption": "VA21",
"proratedOfferGroupCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"purchaseQuantity": 10,
"routeToMarket": "string",
"serviceDefinedAttributes": [
{
"name": "string",
"value": "string"
}
],
"serviceDefinitionId": "8a27ac37-66f1-4a03-be36-dbe55b05f96c",
"status": "ACTIVE",
"supportLevel": "Basic",
"uom": "HOST"
}
],
"offers": [
{
"additionalAttributes": {},
"billingFrequency": "PREPAID",
"billingModel": "string",
"billingTerm": 1,
"billingTermUom": "MONTHS",
"chargeId": "VOD-DBC-01",
"chargeType": "STANDARD",
"components": [
{
"description": "A long Service Standard Offer description",
"productFamily": "VMC-AWS",
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"quantity": 5
}
],
"configErrors": [
{
"allowedValues": [
"string"
],
"errorCode": "string",
"fieldName": "licenseUnit",
"message": "Blah failed. Orphaned Addon needs to be adjusted",
"referenceId": "cb2425b4-203b-4a2a-8a72-2555aa7d4ec6",
"ruleId": "rule123"
}
],
"customerSegment": "COMMERCIAL",
"dataCenter": "US-WEST1",
"deprovisioning": "string",
"description": "A non localized description of offer",
"exchangeOffers": [
{
"deprovisioning": "string",
"flexExchangeDateTime": "2021-03-02T00:05:01.194Z",
"purchaseQuantity": 10,
"referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
"status": "string",
"type": "string"
}
],
"flexExchangeDateTime": "2021-03-02T00:05:01.194Z",
"hostingType": "SHARED",
"isMandatoryInOfferGroup": false,
"licenseUnit": "DEVICE",
"name": "VMware Cloud on AWS",
"offerCategory": "string",
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerConfigGroups": [
{
"allocatedQuantity": 5,
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerRuleValidationReferenceId": "eb660ba4-08d1-49ac-a497-c19cb3c098a9"
}
],
"offerCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"offerEndDateTime": "2020-04-07T00:05:01.194Z",
"offerGroupMultiplier": 5,
"offerLabels": {
"offerLabels": "string"
},
"offerStartDateTime": "2020-04-07T00:05:01.194Z",
"offerSubCategory": "string",
"offerTimelineGroupId": "704b3943-93bb-4f5e-a3eb-396253cf1808",
"offerType": "COMMIT",
"operatingSystem": "Linux",
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"programOption": "VA21",
"proratedOfferCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"purchaseQuantity": 10,
"referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
"region": "EMEA",
"retentionPeriod": "P2M",
"routeToMarket": "string",
"serviceDefinedAttributes": [
{
"name": "string",
"value": "string"
}
],
"serviceDefinitionId": "8a27ac37-66f1-4a03-be36-dbe55b05f96c",
"status": "string",
"statusChangeDateTime": "2020-04-07T00:05:01.194Z",
"supportLevel": "Basic",
"tierDescription": "string",
"tierName": "T1",
"uom": "HOST",
"uomTimeScale": "HOUR",
"usageItems": [
{
"additionalAttributes": {},
"billingFrequency": "PREPAID",
"billingModel": "string",
"billingTerm": 1,
"billingTermUom": "MONTHS",
"chargeId": "VOD-DBC-01",
"chargeType": "STANDARD",
"components": [
{
"description": "A long Service Standard Offer description",
"productFamily": "VMC-AWS",
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"quantity": 5
}
],
"configErrors": [
{
"allowedValues": [
"string"
],
"errorCode": "string",
"fieldName": "licenseUnit",
"message": "Blah failed. Orphaned Addon needs to be adjusted",
"referenceId": "cb2425b4-203b-4a2a-8a72-2555aa7d4ec6",
"ruleId": "rule123"
}
],
"customerSegment": "COMMERCIAL",
"dataCenter": "US-WEST1",
"description": "A non localized description of offer",
"hostingType": "SHARED",
"isMandatoryInOfferGroup": false,
"licenseUnit": "DEVICE",
"name": "VMware Cloud on AWS",
"offerCategory": "string",
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerConfigGroups": [
{
"allocatedQuantity": 5,
"offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
"offerRuleValidationReferenceId": "eb660ba4-08d1-49ac-a497-c19cb3c098a9"
}
],
"offerCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"offerGroupMultiplier": 5,
"offerLabels": {
"offerLabels": "string"
},
"offerSubCategory": "string",
"offerTimelineGroupId": "704b3943-93bb-4f5e-a3eb-396253cf1808",
"offerType": "COMMIT",
"operatingSystem": "Linux",
"productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
"programOption": "VA21",
"proratedOfferCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"purchaseQuantity": 10,
"referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
"region": "EMEA",
"retentionPeriod": "P2M",
"routeToMarket": "string",
"serviceDefinedAttributes": [
{
"name": "string",
"value": "string"
}
],
"serviceDefinitionId": "8a27ac37-66f1-4a03-be36-dbe55b05f96c",
"supportLevel": "Basic",
"tierDescription": "string",
"tierName": "T1",
"uom": "HOST",
"uomTimeScale": "HOUR",
"usageSubmissionModel": "string"
}
],
"usageSubmissionModel": "string"
}
],
"orgId": "485a55fc-b853-40ee-b869-a1b2988e509c",
"partners": [
{
"level": 0,
"partnerAddressId": "1-UXSJ7J",
"partnerOrgId": "485a55fc-b853-40ee-b869-a1b2988e509c",
"type": "string"
}
],
"paymentDetail": {
"billingAccountId": "db36fc9b-6fde-4f10-8f32-2b2524a574fc",
"methodDetail": {
"attributes": [
{
"name": "expirationDate",
"value": {}
}
],
"errorList": [
{
"errorCode": "string",
"errorMessage": "Fund is orphaned"
}
],
"isValid": false,
"sellerPaymentMethodId": "GRP1234",
"sellerPaymentMethodType": "FUND"
},
"orgId": "485a55fc-b853-40ee-b869-a1b2988e509c",
"partnerBillingAccountId": "db36fc9b-6fde-4f10-8f32-2b2524a574fc",
"partnerOrgId": "485a55fc-b853-40ee-b869-a1b2988e509c",
"paymentMethodId": "839e9516-7e92-4485-a1e8-fd4845583d7e",
"seller": "VMWARE",
"sellerPaymentMethodId": "GRP12345",
"sellerPaymentMethodType": "FUND",
"subscriptionPaymentLevel": "string",
"subscriptionPaymentOverrideType": "string"
},
"region": "EMEA",
"renewalPreference": "string",
"renewalWindowEndDateTime": "2020-04-07T00:05:01.194Z",
"renewalWindowStartDateTime": "2020-04-07T00:05:01.194Z",
"serviceDefinitionId": "d27a99af-f433-4427-a58a-acdc01c9e3f8",
"serviceDefinitionIds": [
"d27a99af-f433-4427-a58a-acdc01c9e3f8"
],
"status": "string",
"statusChangeDateTime": "2020-04-07T00:05:01.194Z",
"subscriptionCost": {
"creditSavings": [
{
"creditAmount": -1.5,
"creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
"type": "string"
}
],
"discountSavings": [
{
"attributes": {
"attributes": "string"
},
"discountAmount": -1.5,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": -58.63,
"promotionCode": "VMC_AWS_10_PERCENT_OFF",
"promotionName": "Promo description",
"promotionPercent": 0.1,
"promotionServiceDetails": [
{
"description": "VMware Cloud DR",
"productFamily": "VMC-AWS",
"serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
}
],
"promotionType": "PERCENTAGE (or) AMOUNT",
"remainingAmount": -28.63,
"sellerPromotionInstanceId": "20"
}
],
"prorationFactor": 0.6,
"remainingContractValue": 421.68,
"surrenderValue": 421.68,
"totalContractValue": 421.68,
"totalCreditSavings": -1.63,
"totalDiscountSavings": -10,
"totalListContractValue": 41.68,
"totalListPrice": 586.32,
"totalNetAmount": 421.68,
"totalPromotionSavings": -158.63,
"totalSalePrice": 576.32,
"totalTaxes": 5.62,
"transitionPeriodCost": 121.38,
"transitionalPrices": {
"anet": 1.5,
"cnet": 2.5,
"enet": 3.5
},
"unitListContractValue": 1.68,
"unitListPrice": 12.32,
"unitNetAmount": 21.68,
"unitTotalContractValue": 31.68,
"unitTotalListContractValue": 89.49
},
"subscriptionEndDateTime": "2020-04-07T00:05:01.194Z",
"subscriptionGroupId": "9488dda7-8593-44f2-b070-bcd1dc7a264b",
"subscriptionId": "f9971a9e-de15-4abb-a732-a24bfa3378a6",
"subscriptionStartDateTime": "2020-04-07T00:05:01.194Z",
"subscriptionType": "COMMIT",
"transitionStatus": "string",
"version": "V3"
}
string
billingEngine
Required
The underlying billing engine, example: SAP, SDP
Possible values are :
SDP,
ZUORA,
SAP,
AWS_CP,
MPCB,
string
billingEngineSubscriptionId
Optional
The underlying billingEngine subscription id. Note it maybe null/not set if subscription is not yet created in Billing Engine or if it failed to create
string
billingModel
Required
The billing model of the service definition id on the offer group
Possible values are :
COMMIT_REQUIRED,
COMMIT_OPTIONAL,
COMMIT_ONLY,
object
context
Optional
A Map<String,String> that is persisted in CSP upon CREATE operation. Note this is for v1 compatibility only and use is not recommended. Please use the context at the transaction level instead.
string
creationDateTime
Required
When first subscription transaction was executed
string
currency
Required
ISO Currency 3 letter code for subscription currency
string
displayBillingEngineSubscriptionId
Optional
The billingEngine subscription id that is displayed to customers. It may be null/not set
boolean
flexExchangeLock
Optional
True if currently this subscription is locked and not available for exchange
array of
string
insights
Optional
Generic collection containing set of values characterising the subscription. If there are offers with BASE supportLevel this collection may have [BASE].If there are offers with TUC upgrade for programOption values will be [BASE, UPGRADE] and so on.If there is a ongoing transfer between organizations value will be [SUBSCRIPTION_MOBILITY_IN_PROGRESS].So insights shows in one place what's insight the offers/subscription.
Possible values are :
UPGRADE,
MIGRATED,
TLSS_BUNDLE,
SUBSCRIPTION_MOBILITY_IN_PROGRESS,
array of
object
offerGroups
Optional
Offer groups in the subscription with current statuses
array of
object
offers
Required
Offers in subscription with current statuses
string
orgId
Required
The subscribing org id
array of
object
partners
Optional
A list of 1 or more partners related to this subscription
object
paymentDetail
Required
Payment details for this subscription. Maybe be null if not found, then refer to reasonCode
string
region
Required
The subscription region. Same as the region in all nested offer(s)
string
renewalPreference
Required
Constraints:
default: MANUAL
Renewal Preference. Set in billing engine
Possible values are :
AUTO,
MANUAL,
CANCEL,
string
renewalWindowEndDateTime
Optional
End of renewal window
string
renewalWindowStartDateTime
Optional
Start of renewal window
string
serviceDefinitionId
Required
The service definition ID that this subscription belongs to. Applicable for stand-alone offers only. Marked as deprecated. Use serviceDefinitionIds instead.
array of
string
serviceDefinitionIds
Required
The service definition IDs that this multi-service subscription belongs to. Service definition IDs of bundle and non-bundle offers.
string
status
Required
Status
Possible values are :
SUBMITTED,
CREATED,
ACTIVE,
SUSPENDED,
CANCELLED,
TERMINATED,
ERROR,
PENDING_EXPIRY,
EXPIRED,
string
statusChangeDateTime
Required
When status was last changed
object
subscriptionCost
Optional
Offer cost, for more info see: https://confluence.eng.vmware.com/x/PUJNNQ
string
subscriptionEndDateTime
Optional
Subscription end date time, not applicable for on-demand
string As uuid
As uuid
subscriptionGroupId
Optional
The CSP subscription group ID
string
subscriptionId
Required
The CSP subscription id
string
subscriptionStartDateTime
Optional
Subscription start date time
string
subscriptionType
Required
Subscription Type, current choice: COMMIT, ONDEMAND
Possible values are :
ONDEMAND,
COMMIT,
string
transitionStatus
Optional
Subscription transition status. Standard or P2S (Perpetual to subscription - if any of the offers is perpetual).
Possible values are :
NONE,
PERPETUAL_TO_SUBSCRIPTION,
string
version
Required
The SPI version of this resource
Possible values are :
V1,
V3,
401
The user is not authorized to use the API
Returns
CspErrorResponse
of type(s)
application/json
"CspErrorResponse Object"
string
cspErrorCode
Optional
cspErrorCode
string
errorCode
Optional
errorCode
string
message
Optional
message
integer As int32
As int32
moduleCode
Optional
moduleCode
string
requestId
Optional
requestId
integer As int32
As int32
statusCode
Optional
statusCode
403
The user is forbidden to use the API
Returns
CspErrorResponse
of type(s)
application/json
"CspErrorResponse Object"
string
cspErrorCode
Optional
cspErrorCode
string
errorCode
Optional
errorCode
string
message
Optional
message
integer As int32
As int32
moduleCode
Optional
moduleCode
string
requestId
Optional
requestId
integer As int32
As int32
statusCode
Optional
statusCode
404
Request error, see error code for details
Returns
CspErrorResponse
of type(s)
application/json
"CspErrorResponse Object"
string
cspErrorCode
Optional
cspErrorCode
string
errorCode
Optional
errorCode
string
message
Optional
message
integer As int32
As int32
moduleCode
Optional
moduleCode
string
requestId
Optional
requestId
integer As int32
As int32
statusCode
Optional
statusCode
429
The user has sent too many requests
Returns
CspErrorResponse
of type(s)
application/json
"CspErrorResponse Object"
string
cspErrorCode
Optional
cspErrorCode
string
errorCode
Optional
errorCode
string
message
Optional
message
integer As int32
As int32
moduleCode
Optional
moduleCode
string
requestId
Optional
requestId
integer As int32
As int32
statusCode
Optional
statusCode
500
Unexpected error
Returns
CspErrorResponse
of type(s)
application/json
"CspErrorResponse Object"
string
cspErrorCode
Optional
cspErrorCode
string
errorCode
Optional
errorCode
string
message
Optional
message
integer As int32
As int32
moduleCode
Optional
moduleCode
string
requestId
Optional
requestId
integer As int32
As int32
statusCode
Optional
statusCode
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/commerce/api/v3/subscriptions/{subscriptionId}
On This Page
Subscriptions Operations
GET
Get Paged Subscriptions V3 Using GET
GET
Get Subscription V3 Using GET