V3SubscriptionAmendOffer
V3SubscriptionAmendOffer
Standalone offer(s) for amendment
JSON Example
{
"additionalAttributes": {},
"addonOffers": [
{
"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"
}
],
"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",
"exchangeOffers": [
{
"referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6"
}
],
"hostingType": "SHARED",
"isMandatoryInOfferGroup": false,
"licenseUnit": "DEVICE",
"mandatoryOffers": [
{
"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"
}
],
"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",
"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"
}
object
additionalAttributes
Optional
Billing engine specific JSON payload that CSP does not process
array of
V3SubscriptionOfferBase
addonOffers
Optional
Addon Offers, applicable only on create/amend/renewal request if related offer needs to be sent
string
billingFrequency
Optional
Billing frequency
Possible values are :
PREPAID,
MONTHLY,
ANNUAL,
billingModel
Optional
The billing model of the service definition id on the offer group
Possible values are :
COMMIT_REQUIRED,
COMMIT_OPTIONAL,
COMMIT_ONLY,
integer As int32
As int32
billingTerm
Optional
Applicable only for COMMIT
string
billingTermUom
Optional
Applicable only for COMMIT
string
chargeId
Optional
Applicable only for COMMIT
string
chargeType
Optional
Charge type
Possible values are :
FLAT_FEE,
PER_UNIT,
STANDARD,
TIERED,
array of
V3OfferComponent
components
Optional
Bundle components. Applicable only for COMMIT. Marked as deprecated. Use offerGroups in the subscription response instead.
array of
V3SubscriptionConfigurationError
configErrors
Optional
CPQ configuration errors response at this level. See https://confluence.eng.vmware.com/x/IS79Og
string
customerSegment
Optional
Customer segment
Possible values are :
ACADEMIC,
COMMERCIAL,
GOVERNMENT,
string
dataCenter
Optional
Data center
string
description
Optional
Offer description from billing engine, on get subscription only
exchangeOffers
Optional
Reference offer for exchange(s) if original offer is to be exchanged
string
hostingType
Optional
Shared Cloud or Managed hosting type
boolean
isMandatoryInOfferGroup
Optional
Applicable for offer group offers only. In the example isOfferMandatory: true, this offer is required in the offer-group.
string
licenseUnit
Optional
License unit
array of
V3SubscriptionOfferBase
mandatoryOffers
Optional
Mandatory Offers, applicable only on create/amend/renewal request if related offer needs to be sent
string
name
Optional
Offer name
string
offerCategory
Optional
The offer category
Possible values are :
PRIMARY,
ADDON,
ONETIME,
ONDEMAND,
string
offerConfigGroupId
Optional
This applies to Amend only and is optional. Offer grouping id to identify all offers in a subscription that are related due to Primary/Addon relationship
array of
V3SubscriptionOfferConfigGroup
offerConfigGroups
Optional
This applies to GET subscriptions only and is required. Offer groupings to identify all offers in a subscription that are related due to Primary/Addon relationship
offerCost
Optional
Offer cost, for more info see: https://confluence.eng.vmware.com/x/PUJNNQ
number As double
As double
offerGroupMultiplier
Optional
Offer group multiplier is applicable only for offers within offer-groups. In the example ratio: 5, purchaseQuantity of the offer within offer-group is 5 times of the offer-group.
object
offerLabels
Optional
Offer labels of the standalone offer. Offer labels are key-value pairs used to tag a group of offers with a label.
string
offerSubCategory
Optional
Offer sub-category
Possible values are :
FLEX,
BUNDLE,
PH_HOSTING,
PH_SNS_FOR_BASE,
PH_SNS_FOR_ADDON,
PS_REGULAR,
PS_CONFIGURABLE,
PH_BASE_SW,
PH_ADDON_SW,
OVERAGE,
REGISTRATION,
CONFIG_BUNDLE,
TEMPLATE_BUNDLE,
string
offerTimelineGroupId
Optional
Offer grouping id to identify all offers in a subscription that are related due to FCT or renewal. Required for GET subscriptions only.
string
offerType
Required
Offer Type
Possible values are :
ONDEMAND,
COMMIT,
string
operatingSystem
Optional
Offer operating system if applicable
string
productId
Required
Globally unique product id from Offer response
string
programOption
Optional
Program eligibility
proratedOfferCost
Optional
Offer cost, for more info see: https://confluence.eng.vmware.com/x/PUJNNQ
integer As int32
As int32
purchaseQuantity
Optional
Constraints:
minimum: 0
quantity for purchase. Applicable only for COMMIT
string
referenceId
Optional
(Only for offer amend/create response) A unique id that is referenced to in subsequent transactions like status change, exchange etc. This NOT an offer or SKU id. This is unique per instance of offer purchase.
string
region
Optional
Region. This is deprecated in favor of region at subscription level
string
retentionPeriod
Optional
Retention period if applicable. Usually months. The supported units of a period are YEARS, MONTHS and DAYS. All three fields are always present, but may be set to zero. Format spec: https://en.wikipedia.org/wiki/ISO_8601#Durations. Java doc: https://docs.oracle.com/javase/8/docs/api/java/time/Period.html
string
routeToMarket
Required
RTM
Possible values are :
DIRECT,
RESELLER,
DISTRIBUTOR,
MSP,
array of
ServiceDefinedAttribute
serviceDefinedAttributes
Optional
Service specific attributes. Those are treated as any other offer attribute(such as billingTerm, region, etc) and allow for services to define custom attributes applicable only for their offers. This is not the same as the metadata field, which is for arbitrary data.Billing engine specific attributes such as externalSKU, shellId are also defined here.
string
serviceDefinitionId
Optional
Service Definition tied to offer.
string
supportLevel
Optional
Level of support available, e.g. Production, Basic
string
tierDescription
Optional
Tier description
string
tierName
Optional
Tier name. Tier attributes will be populated in case of tier volume pricing. Applicable only when chargeType is TIERED
string
uom
Optional
Applicable for commit offer only. Each service may have its own UOM. Some services may use Host and others may use CPUs...etc
string
uomTimeScale
Optional
Applicable for commit offer only. Services may apply hour, day or month against UOM, such as Host-Hour, GB per month. Only Hour is currently supported
string
usageSubmissionModel
Optional
The usage submission variants applicable for models that support usage
Possible values are :
RAW,
PRE_COMPUTED,
NOT_APPLICABLE,