[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Offer

Response Model for an Offer


Properties

map of string
additionalAttributes Optional

A Map<String, String> that holds extra information about the offer


string
billingFrequency Optional

Billing frequency of the offer

Possible values are: PREPAIDMONTHLYANNUAL


string
billingModel Optional

The offer billing model based on supported models

Possible values are: COMMIT_REQUIREDCOMMIT_OPTIONALCOMMIT_ONLY


integer as int32
billingTerm Optional

Offer billing term, applicable only for COMMIT


string
chargeId Optional

Offer charge id, Applicable only for COMMIT


array of OfferComponent
components Optional

List of all Bundle components for the offer


string
crossRefSku Optional

SKU of the offer based on the offer attributes


string
currency Optional

Currency used to purchase the offer


string
description Optional

Offer description from billing engine


string
endDate Optional

End date time of the offer


string
hostingType Optional

Shared Cloud or Managed hosting type


string
licenseUnit Optional

License Unit of the offer


string
name Optional

Given name of the offer


string
offerCategory Optional

Category of the offer such as Primary, Addon or Onetime

Possible values are: PRIMARYADDONONETIME


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


offerCost Optional

Cost object for a subscription


string
offerType Optional

Type of Offer such as On-Demand or Commit

Possible values are: ONDEMANDCOMMIT


string
productId Optional

Globally unique product id for the offer


string
programOption Optional

Program eligibility such as Subscription Upgrade


integer as int32
purchaseQuantity Optional

Quantity for purchase. Applicable only for COMMIT


string
quantityUom Optional

Purchase quantity Unit Of Measurement


string
referenceId Optional

Reference ID of the offer


string
region Optional

The region for which the offer is valid


serviceRef Optional

Reference object containing minimal details of a service


string
startDate Optional

Start date time of the offer


string
status Optional

Lifecycle status of the offer

Possible values are: SUBMITTEDPENDING_PROVISIONINGERRORACTIVEPENDING_CANCELCANCELLEDTERMINATEDPENDING_ACTIVEEXPIRED


string
supportLevel Optional

Level of support available for the offer


string
tierName Optional

Tier name. Tier attributes will be populated in case of tier volume pricing. Applicable only when chargeType is TIERED


array of UsageItem
usageItems Optional

List of usage items for the offer


string
usageSubmissionModel Optional

The usage submission variants applicable for models that support usage

JSON Example

{
	"additionalAttributes": {
		"key": "string"
	},
	"billingFrequency": "PREPAID",
	"billingModel": "COMMIT_REQUIRED",
	"billingTerm": 0,
	"chargeId": "string",
	"components": [
		{
			"description": "string",
			"productFamily": "string",
			"productId": "string",
			"quantity": 0
		}
	],
	"crossRefSku": "string",
	"currency": "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",
	"productId": "string",
	"programOption": "string",
	"purchaseQuantity": 0,
	"quantityUom": "string",
	"referenceId": "string",
	"region": "string",
	"serviceRef": {
		"id": "string",
		"name": "string",
		"serviceIcon": "string"
	},
	"startDate": "string",
	"status": "SUBMITTED",
	"supportLevel": "string",
	"tierName": "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"
		}
	],
	"usageSubmissionModel": "string"
}
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Property Of

DistributorSubscriptionDetails
ResellerSubscriptionDetails

Feedback

Was this page helpful?