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

cloud-partner-navigator

BaseOfferConfig

Defines the properties of the Base Offer Config.

Properties

string

name Required

The name of the base 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 base offer.

string

offerCategory Required

The category of the base offer 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 list of components of the base offer.

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 decription of the base offer.

string

endDate Optional

The end date of the base offer.

string

hostingType Optional

The hosting type.

boolean

isMandatory Optional

string

licenseUnit Optional

The license unit.

string

chargeId Optional

The charge id of the base offer.

string

billingTermUom Optional

The billing term uom example - ‘MONTHS’

Possible values are: MONTHS

string

offerConfigGroupId Optional

The offer config group Id of the base offer.

CostObject

offerCost Optional

Defines the properties of the Cost Object.

array of string

offerReferenceIds Optional

The list of offer Reference Ids.

string

offerType Optional

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

Possible values are: ONDEMAND , COMMIT

string

operatingSystem Optional

The operating system

string

productId Optional

The product id of the offer.

string

programOption Optional

The program option

integer as int32

billingTerm Optional

The billing term of the base offer.

string

quantityUom Optional

The quantity Uom.

string

referenceId Optional

The reference Id of the base offer.

string

region Optional

The region.

string

retentionPeriod Optional

The retention period of the base 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 base offer.

string

status Optional

The status of the base offer.

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

string

supportLevel Optional

The support level of the base offer.

string

tierName Optional

The tier name.

number as double

totalCreditSavings Optional

The total credit savings.

number as double

totalListContractValue Optional

The total list contract value of the base offer.

number as double

totalListPrice Optional

The total list price of the base offer.

string

uom Optional

The uom.

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",
	"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

ConsolidatedOffer

BaseOfferConfig

Properties

JSON Example

Property Of

Was this page helpful?