[{"label":"Latest (v1)","version":"latest"}]

cloud-partner-navigator

AmendOffer

Defines the properties of the Amend Offer.

Properties

string

name Required

The name of the offer.

integer as int32

purchaseQuantity Required

The purchase quantity of the offers.

string

billingModel Required

The billing model example - ‘COMMIT_REQUIRED’ ‘COMMIT_OPTIONAL’ ‘COMMIT_ONLY’

Possible values are: COMMIT_REQUIRED , COMMIT_OPTIONAL , COMMIT_ONLY

string

offerCategory Required

The category of offers example - ‘PRIMARY’ ‘ADDON’ ‘ONETIME’ ‘ONDEMAND’

Possible values are: PRIMARY , ADDON , ONETIME , ONDEMAND

array of BaseOffer

addOnOffers Optional

The list of the add on offers.

string

chargeId Optional

The charge id of the offer.

array of OfferComponent

components Optional

The list of offer components.

string

crossRefSku Optional

The cross ref sku.

string

currency Optional

The type of currency.

string

customerSegment Optional

The customer segment example - ‘ACADEMIC’ ‘COMMERCIAL’ ‘GOVERNMENT’

Possible values are: ACADEMIC , COMMERCIAL , GOVERNMENT

string

dataCenter Optional

The data center.

string

description Optional

The description of the offer.

string

endDate Optional

The end date of the offer.

array of ExchangeOfferRef

exchangeOffers Optional

The list of the exchange offers.

string

hostingType Optional

The hosting type of the offers.

string

licenseUnit Optional

The license unit.

string

billingTermUom Optional

The billing term uom

Possible values are: MONTHS

integer as int32

billingTerm Optional

The billing term of the offer.

string

offerConfigGroupId Optional

The identifier offer Config Group.

CostObject

offerCost Optional

Defines the properties of the Cost Object.

string

offerType Optional

The offer type example - ‘ONDEMAND’ ‘COMMIT’

Possible values are: ONDEMAND , COMMIT

string

operatingSystem Optional

The operating system.

string

productId Optional

The product id of the offer.

string

billingFrequency Optional

The billing frequency example - ‘PREPAID’ ‘MONTHLY’ ‘ANNUAL’

Possible values are: PREPAID , MONTHLY , ANNUAL

string

quantityUom Optional

The quantity uom of offers.

string

referenceId Optional

The reference id of the offer.

string

region Optional

The region of the offers.

string

retentionPeriod Optional

The retention period of the offer.

string

routeToMarket Optional

The route to market example - ‘DIRECT’ ‘RESELLER’ ‘DISTRIBUTOR’

Possible values are: DIRECT , RESELLER , DISTRIBUTOR

string

startDate Optional

The start date of the offer.

string

status Optional

The status of the offer example - ‘SUBMITTED’ ‘PENDING_PROVISIONING’ ‘ERROR’ etc

Possible values are: SUBMITTED , PENDING_PROVISIONING , ERROR , ACTIVE , PENDING_CANCEL , CANCELLED , TERMINATED , PENDING_ACTIVE , EXPIRED

string

supportLevel Optional

The support level of the offers

string

tierName Optional

The tier name of the offers.

number as double

totalCreditSavings Optional

The total credit savings.

number as double

totalListContractValue Optional

The total list contract value of offers.

number as double

totalListPrice Optional

The total list price of offers

string

uom Optional

The uom.

array of UsageItem

usageItems Optional

The list of the usage items.

JSON Example

Show optional properties

{
	"billingModel": "COMMIT_REQUIRED",
	"name": "string",
	"offerCategory": "PRIMARY",
	"purchaseQuantity": 0
}

{
	"addOnOffers": [
		{
			"billingFrequency": "PREPAID",
			"billingModel": "COMMIT_REQUIRED",
			"billingTerm": 0,
			"billingTermUom": "MONTHS",
			"chargeId": "string",
			"components": [
				{
					"description": "string",
					"productFamily": "string",
					"productId": "string",
					"quantity": 0
				}
			],
			"crossRefSku": "string",
			"currency": "string",
			"customerSegment": "ACADEMIC",
			"dataCenter": "string",
			"description": "string",
			"endDate": "string",
			"hostingType": "string",
			"licenseUnit": "string",
			"name": "string",
			"offerCategory": "PRIMARY",
			"offerConfigGroupId": "string",
			"offerCost": {
				"creditSavings": [
					{
						"creditAmount": 0,
						"creditReference": "string",
						"type": "FLEX_EXCHANGE"
					}
				],
				"discountSavings": [
					{
						"attributes": {
							"key": "string"
						},
						"discountAmount": 0,
						"type": "RCD"
					}
				],
				"promotionSavings": [
					{
						"promotionAmount": 0,
						"promotionCode": "string",
						"promotionName": "string",
						"promotionPercent": 0,
						"promotionServiceDetails": [
							{
								"description": "string",
								"productFamily": "string",
								"serviceDefinitionId": "string"
							}
						],
						"promotionType": "PromotionSaving",
						"remainingAmount": 0,
						"sellerPromotionInstanceId": "string"
					}
				],
				"remainingContractValue": 0,
				"totalContractValue": 0,
				"totalCreditSavings": 0,
				"totalDiscountSavings": 0,
				"totalListPrice": 0,
				"totalNetPrice": 0,
				"totalPromotionSavings": 0,
				"totalSalePrice": 0,
				"unitListPrice": 0,
				"unitNetPrice": 0,
				"unitTotalContractValue": 0
			},
			"offerType": "ONDEMAND",
			"operatingSystem": "string",
			"productId": "string",
			"purchaseQuantity": 0,
			"quantityUom": "string",
			"referenceId": "string",
			"region": "string",
			"retentionPeriod": "string",
			"routeToMarket": "DIRECT",
			"startDate": "string",
			"status": "SUBMITTED",
			"supportLevel": "string",
			"tierName": "string",
			"totalCreditSavings": 0,
			"totalListContractValue": 0,
			"totalListPrice": 0,
			"uom": "string",
			"usageItems": [
				{
					"chargeId": "string",
					"chargeType": "string",
					"name": "string",
					"offerCost": {
						"creditSavings": [
							{
								"creditAmount": 0,
								"creditReference": "string",
								"type": "FLEX_EXCHANGE"
							}
						],
						"discountSavings": [
							{
								"attributes": {
									"key": "string"
								},
								"discountAmount": 0,
								"type": "RCD"
							}
						],
						"promotionSavings": [
							{
								"promotionAmount": 0,
								"promotionCode": "string",
								"promotionName": "string",
								"promotionPercent": 0,
								"promotionServiceDetails": [
									{
										"description": "string",
										"productFamily": "string",
										"serviceDefinitionId": "string"
									}
								],
								"promotionType": "PromotionSaving",
								"remainingAmount": 0,
								"sellerPromotionInstanceId": "string"
							}
						],
						"remainingContractValue": 0,
						"totalContractValue": 0,
						"totalCreditSavings": 0,
						"totalDiscountSavings": 0,
						"totalListPrice": 0,
						"totalNetPrice": 0,
						"totalPromotionSavings": 0,
						"totalSalePrice": 0,
						"unitListPrice": 0,
						"unitNetPrice": 0,
						"unitTotalContractValue": 0
					},
					"uom": "string"
				}
			]
		}
	],
	"billingFrequency": "PREPAID",
	"billingModel": "COMMIT_REQUIRED",
	"billingTerm": 0,
	"billingTermUom": "MONTHS",
	"chargeId": "string",
	"components": [
		{
			"description": "string",
			"productFamily": "string",
			"productId": "string",
			"quantity": 0
		}
	],
	"crossRefSku": "string",
	"currency": "string",
	"customerSegment": "ACADEMIC",
	"dataCenter": "string",
	"description": "string",
	"endDate": "string",
	"exchangeOffers": [
		{
			"crossRefSku": "string",
			"description": "string",
			"name": "string",
			"offerConfigGroupId": "string",
			"productId": "string",
			"referenceId": "string"
		}
	],
	"hostingType": "string",
	"licenseUnit": "string",
	"name": "string",
	"offerCategory": "PRIMARY",
	"offerConfigGroupId": "string",
	"offerCost": {
		"creditSavings": [
			{
				"creditAmount": 0,
				"creditReference": "string",
				"type": "FLEX_EXCHANGE"
			}
		],
		"discountSavings": [
			{
				"attributes": {
					"key": "string"
				},
				"discountAmount": 0,
				"type": "RCD"
			}
		],
		"promotionSavings": [
			{
				"promotionAmount": 0,
				"promotionCode": "string",
				"promotionName": "string",
				"promotionPercent": 0,
				"promotionServiceDetails": [
					{
						"description": "string",
						"productFamily": "string",
						"serviceDefinitionId": "string"
					}
				],
				"promotionType": "PromotionSaving",
				"remainingAmount": 0,
				"sellerPromotionInstanceId": "string"
			}
		],
		"remainingContractValue": 0,
		"totalContractValue": 0,
		"totalCreditSavings": 0,
		"totalDiscountSavings": 0,
		"totalListPrice": 0,
		"totalNetPrice": 0,
		"totalPromotionSavings": 0,
		"totalSalePrice": 0,
		"unitListPrice": 0,
		"unitNetPrice": 0,
		"unitTotalContractValue": 0
	},
	"offerType": "ONDEMAND",
	"operatingSystem": "string",
	"productId": "string",
	"purchaseQuantity": 0,
	"quantityUom": "string",
	"referenceId": "string",
	"region": "string",
	"retentionPeriod": "string",
	"routeToMarket": "DIRECT",
	"startDate": "string",
	"status": "SUBMITTED",
	"supportLevel": "string",
	"tierName": "string",
	"totalCreditSavings": 0,
	"totalListContractValue": 0,
	"totalListPrice": 0,
	"uom": "string",
	"usageItems": [
		{
			"chargeId": "string",
			"chargeType": "string",
			"name": "string",
			"offerCost": {
				"creditSavings": [
					{
						"creditAmount": 0,
						"creditReference": "string",
						"type": "FLEX_EXCHANGE"
					}
				],
				"discountSavings": [
					{
						"attributes": {
							"key": "string"
						},
						"discountAmount": 0,
						"type": "RCD"
					}
				],
				"promotionSavings": [
					{
						"promotionAmount": 0,
						"promotionCode": "string",
						"promotionName": "string",
						"promotionPercent": 0,
						"promotionServiceDetails": [
							{
								"description": "string",
								"productFamily": "string",
								"serviceDefinitionId": "string"
							}
						],
						"promotionType": "PromotionSaving",
						"remainingAmount": 0,
						"sellerPromotionInstanceId": "string"
					}
				],
				"remainingContractValue": 0,
				"totalContractValue": 0,
				"totalCreditSavings": 0,
				"totalDiscountSavings": 0,
				"totalListPrice": 0,
				"totalNetPrice": 0,
				"totalPromotionSavings": 0,
				"totalSalePrice": 0,
				"unitListPrice": 0,
				"unitNetPrice": 0,
				"unitTotalContractValue": 0
			},
			"uom": "string"
		}
	]
}

[{"label":"Latest (v1)","version":"latest"}]

cloud-partner-navigator

Property Of

SubscriptionOfferAmendTransaction

AmendOffer

Properties

JSON Example

Property Of

Was this page helpful?