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

cloud-partner-navigator

ConsolidatedOffer

Defines the properties of the Consolidated Offer.

Properties

string

name Required

The name of the consolidated offer.

integer as int32

purchaseQuantity Required

The purchase quantity in the consolidated offer.

string

billingModel Required

The billing model in the consolidated offer, the values can be ‘COMMIT_REQUIRED’ ‘COMMIT_OPTIONAL’ ‘COMMIT_ONLY’.

Possible values are: COMMIT_REQUIRED , COMMIT_OPTIONAL , COMMIT_ONLY

string

offerCategory Required

The offer category of the consolidated offer, the values can be ‘PRIMARY’ ‘ADDON’ ‘ONETIME’ ‘ONDEMAND’.

Possible values are: PRIMARY , ADDON , ONETIME , ONDEMAND

array of BaseOfferConfig

addOnOffers Optional

The list of add on offers in the consolidated offer.

string

chargeId Optional

The charge id of the consolidated offer

array of OfferComponent

components Optional

The list of components in the consolidated offer.

string

crossRefSku Optional

The cross Ref Sku in the consolidated offer.

string

currency Optional

The currency in the consolidated offer.

string

customerSegment Optional

The customer segment of the consolidated offer, the values can be ‘ACADEMIC’ ‘COMMERCIAL’ ‘GOVERNMENT’.

Possible values are: ACADEMIC , COMMERCIAL , GOVERNMENT

string

dataCenter Optional

The data center in the consolidated offer.

string

description Optional

The description of the consolidated offer.

string

endDate Optional

The end date in the consolidated offer.

string

hostingType Optional

The hosting type in the consolidated offer.

boolean

isMandatory Optional

string

licenseUnit Optional

The license unit in the consolidated offer.

string

billingTermUom Optional

The billing term uom in the consolidated offer, the values can be ‘MONTHS’.

Possible values are: MONTHS

integer as int32

billingTerm Optional

The billing term in the consolidated offer.

string

offerConfigGroupId Optional

The offer config group id in the consolidated offer.

CostObject

offerCost Optional

Defines the properties of the Cost Object.

array of string

offerReferenceIds Optional

The list of offer reference Id in the consolidated offer.

string

offerType Optional

The offer type of the consolidated offer, the values can be ‘ONDEMAND’ ‘COMMIT’.

Possible values are: ONDEMAND , COMMIT

string

operatingSystem Optional

The operating system in the consolidated offer.

string

productId Optional

The product id of the consolidated offer.

string

programOption Optional

The program option in the consolidated offer.

string

billingFrequency Optional

The billing frequency in the consolidated offer, the values can be ‘PREPAID’ ‘MONTHLY’ ‘ANNUAL’

Possible values are: PREPAID , MONTHLY , ANNUAL

string

quantityUom Optional

The quantity uom in the consolidated offer.

string

referenceId Optional

The reference id of the consolidated offer.

string

region Optional

The region in the consolidated offer.

string

retentionPeriod Optional

The retention period in the consolidated offer.

string

routeToMarket Optional

The route to market in the consolidated offer, the values can be ‘DIRECT’ ‘RESELLER’ ‘DISTRIBUTOR’.

Possible values are: DIRECT , RESELLER , DISTRIBUTOR

string

startDate Optional

The start date in the consolidated offer.

string

status Optional

The status of the consolidated offer, the values can be ‘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 in the consolidated offer.

string

tierName Optional

The tier name in the consolidated offer.

number as double

totalCreditSavings Optional

The total credit savings in the consolidated offer.

number as double

totalListContractValue Optional

The total list contract value in the consolidated offer.

number as double

totalListPrice Optional

The total list price in the consolidated offer.

string

uom Optional

The uom in the consolidated offer

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",
			"isMandatory": false,
			"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
			},
			"offerReferenceIds": [
				"string"
			],
			"offerType": "ONDEMAND",
			"operatingSystem": "string",
			"productId": "string",
			"programOption": "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"
		}
	],
	"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",
	"isMandatory": false,
	"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
	},
	"offerReferenceIds": [
		"string"
	],
	"offerType": "ONDEMAND",
	"operatingSystem": "string",
	"productId": "string",
	"programOption": "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"
}

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

cloud-partner-navigator

Property Of

CreateTransaction
MspSubscriptionDetails

ConsolidatedOffer

Properties

JSON Example

Property Of

Was this page helpful?