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

DistributorOffer

Model for a distributor’s 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


string
currency Optional

Currency used to purchase the offer


string
description Optional

Offer description from billing engine


array of DiscountSaving
discountSavings Optional

Discount saving on cost of offer


string
endDate Optional

End date time of the offer


string
licenseUnit Optional

License Unit of the offer


number as double
listPrice Optional

List Price for the subscription


string
name Optional

Given name of the offer


number as double
netPrice Optional

Net Price for the subscription


string
offerCategory Optional

Category of the offer such as Primary, Addon or Onetime

Possible values are: PRIMARYADDONONETIME


offerCost Optional

Cost object for a subscription


string
offerType Optional

Type of Offer such as On-Demand or Commit

Possible values are: ONDEMANDCOMMIT


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


serviceRef Optional

Reference object containing minimal details of a service


string
sku Optional

SKU of the offer based on the offer attributes


string
startDate Optional

Start date time of the offer


string
status Optional

Lifecycle status of the offer

Possible values are: SUBMITTEDPENDING_PROVISIONINGERRORACTIVEPENDING_CANCELCANCELLEDTERMINATEDPENDING_ACTIVEEXPIRED


number as double
term Optional

Term for which the offer is applicable


string
tierName Optional

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


number as double
totalDiscount Optional

The total discounts present at this grouping level


number as double
unitListPrice Optional

The list price (MSRP) for 1 quantity. Applicable only in a subscription


number as double
unitNetPrice Optional

Net price for 1 quantity. Applicable only in a subscription


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


number as double
volumeTierDiscount Optional

Volume Tiering Level 2 Discount

JSON Example

{
	"additionalAttributes": {
		"key": "string"
	},
	"billingFrequency": "PREPAID",
	"billingModel": "COMMIT_REQUIRED",
	"currency": "string",
	"description": "string",
	"discountSavings": [
		{
			"attributes": {
				"key": "string"
			},
			"discountAmount": 0,
			"type": "RCD"
		}
	],
	"endDate": "string",
	"licenseUnit": "string",
	"listPrice": 0,
	"name": "string",
	"netPrice": 0,
	"offerCategory": "PRIMARY",
	"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",
	"programOption": "string",
	"purchaseQuantity": 0,
	"quantityUom": "string",
	"referenceId": "string",
	"serviceRef": {
		"id": "string",
		"name": "string",
		"serviceIcon": "string"
	},
	"sku": "string",
	"startDate": "string",
	"status": "SUBMITTED",
	"term": 0,
	"tierName": "string",
	"totalDiscount": 0,
	"unitListPrice": 0,
	"unitNetPrice": 0,
	"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"
		}
	],
	"usageSubmissionModel": "string",
	"volumeTierDiscount": 0
}
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Property Of

DistributorTransactionInfo

Feedback

Was this page helpful?