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

cloud-partner-navigator

BaseOffer

Defines the properties of the Base Offer.

Properties

string

name Required

The name of the offer.

string

billingModel Required

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

Possible values are: COMMIT_REQUIRED , COMMIT_OPTIONAL , COMMIT_ONLY

integer as int32

purchaseQuantity Required

The purchase Quantity of the offer.

string

offerCategory Required

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

Possible values are: PRIMARY , ADDON , ONETIME , ONDEMAND

string

billingFrequency Optional

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

Possible values are: PREPAID , MONTHLY , ANNUAL

array of OfferComponent

components Optional

The component of the offer.

string

crossRefSku Optional

The cross Ref Sku of the offer.

string

currency Optional

The currency of the offer.

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.

string

hostingType Optional

The hosting Type.

string

licenseUnit Optional

The license unit.

string

chargeId Optional

The charge id of the offer.

string

billingTermUom Optional

The billing term Uom of the offer example - ‘MONTHS’

Possible values are: MONTHS

string

offerConfigGroupId Optional

The offer config group Id of the offer.

CostObject

offerCost Optional

Defines the properties of the Cost Object.

string

offerType Optional

The type of offer example - ‘ONDEMAND’ ‘COMMIT’

Possible values are: ONDEMAND , COMMIT

string

operatingSystem Optional

The operating system.

string

productId Optional

The product id of the offer.

integer as int32

billingTerm Optional

The billing term of the offer.

string

quantityUom Optional

The quantity Uom of the offer.

string

referenceId Optional

The reference Id of the offer

string

region Optional

The region of the offer.

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 offer.

string

tierName Optional

The tier name.

number as double

totalCreditSavings Optional

The total credit savings on the offer.

number as double

totalListContractValue Optional

The total list contract value of the offer.

number as double

totalListPrice Optional

The total list price of the offer.

string

uom Optional

The uom.

array of UsageItem

usageItems Optional

The list of usage items.

JSON Example

Show optional properties

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

{
	"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": {
		"cNetPrice": 0,
		"creditSavings": [
			{
				"creditAmount": 0,
				"creditReference": "string",
				"type": "FLEX_EXCHANGE"
			}
		],
		"discountSavings": [
			{
				"attributes": {
					"key": "string"
				},
				"discountAmount": 0,
				"type": "RCD"
			}
		],
		"snsCredit": 0,
		"totalCreditSavings": 0,
		"totalDiscountSavings": 0,
		"totalListPrice": 0,
		"totalNetPrice": 0,
		"unitListPrice": 0,
		"unitNetPrice": 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",
			"crossRefSku": "string",
			"currency": "string",
			"description": "string",
			"name": "string",
			"offerCost": {
				"cNetPrice": 0,
				"creditSavings": [
					{
						"creditAmount": 0,
						"creditReference": "string",
						"type": "FLEX_EXCHANGE"
					}
				],
				"discountSavings": [
					{
						"attributes": {
							"key": "string"
						},
						"discountAmount": 0,
						"type": "RCD"
					}
				],
				"snsCredit": 0,
				"totalCreditSavings": 0,
				"totalDiscountSavings": 0,
				"totalListPrice": 0,
				"totalNetPrice": 0,
				"unitListPrice": 0,
				"unitNetPrice": 0
			},
			"productId": "string",
			"purchaseQuantity": 0,
			"tierName": "string",
			"uom": "string"
		}
	]
}

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

cloud-partner-navigator

Property Of

AmendOffer
MspSubscriptionDetails

BaseOffer

Properties

JSON Example

Property Of

Was this page helpful?