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

cloud-partner-navigator

CreateOfferRequest

Model for base offer details

Properties

string

offerCategory Required

Category of the offer such as Primary, Addon or Onetime

Possible values are: PRIMARY , ADDON , ONETIME

string

productId Required

Globally unique product id of the bundle shell SKU

array of BaseOfferConfigRequest

addOnOffers Optional

List of add-on offers with their details

string

billingModel Optional

The offer billing model based on supported models

string

billingTerm Optional

Applicable only for COMMIT offer

string

billingTermUom Optional

Applicable only for COMMIT offer

Possible values are: MONTHS

string

categoryId Optional

Category id for the offer. If present for offers need to send in the request

string

countryCode Optional

ISO code of the country

string

crossRefSku Optional

SKU of the offer purchased based on offer attributes

string

currency Optional

Currency used to purchase the offer

string

customerSegment Optional

Segment type of the customer

Possible values are: ACADEMIC , GOVERNMENT , COMMERCIAL

string

dataCenter Optional

Data center where the service is hosted

string

description Optional

Long name of the offer

string

endDate Optional

End date time of the offer

string

hostingType Optional

Shared Cloud or Managed hosting type

boolean

isMandatory Optional

Whether or not the offer is mandatory

number

licenseQuantity Optional

Quantity of the licensed product

string

licenseUnit Optional

License Unit of the offer

array of LicenseDetailsWithConversionFactor

licenses Optional

List of licenses with their details

string

name Optional

Given name of the offer

string

billingFrequency Optional

Billing frequency of the offer

Possible values are: PREPAID , MONTHLY , ANNUAL

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

array of string

offerReferenceIds Optional

List of offer reference IDs

string

offerType Optional

Type of Offer such as On-Demand or Commit

Possible values are: ONDEMAND , COMMIT

string

operatingSystem Optional

Operating system on which the service is running

string

productFamily Optional

Product Group associated with the offers

map of string

additionalAttributes Optional

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

string

programOption Optional

Program eligibility such as Subscription Upgrade

integer as int32

purchaseQuantity Optional

Quantity for purchase. Applicable only for COMMIT

string

region Optional

Region where the offer is applicable

string

repriceOption Optional

Whether or not offer should be repriced

Possible values are: YES , NO

string

retentionPeriod Optional

Retention period of the offer

string

routeToMarket Optional

The route taken to place the order such as Sales, Reseller, etc

Possible values are: DIRECT , RESELLER , DISTRIBUTOR

string

serviceDefinitionId Optional

Service definition id associated with the offers. Either serviceDefinitionId or productFamily needs to be passed.

string

sku Optional

SKU of the offer purchased based on offer attributes

string

startDate Optional

Start date time of the offer

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

JSON Example

Show optional properties

{
	"offerCategory": "PRIMARY",
	"productId": "string"
}

{
	"addOnOffers": [
		{
			"additionalAttributes": {
				"key": "string"
			},
			"billingFrequency": "PREPAID",
			"billingModel": "string",
			"billingTerm": "string",
			"billingTermUom": "MONTHS",
			"categoryId": "string",
			"countryCode": "string",
			"crossRefSku": "string",
			"currency": "string",
			"customerSegment": "ACADEMIC",
			"dataCenter": "string",
			"description": "string",
			"endDate": "string",
			"hostingType": "string",
			"isMandatory": false,
			"licenseQuantity": 0,
			"licenseUnit": "string",
			"licenses": [
				{
					"contactEmail": "string",
					"conversionRatio": 0,
					"conversionRatioUnit": "string",
					"eligibleQuantity": 0,
					"expirationDate": "string",
					"licenseKey": "string",
					"licenseUnit": "string",
					"productDetails": {
						"displayName": "string",
						"product": "string"
					},
					"selectedQuantity": 0,
					"status": "string",
					"totalQuantity": 0
				}
			],
			"name": "string",
			"offerCategory": "PRIMARY",
			"offerConfigGroupId": "string",
			"offerReferenceIds": [
				"string"
			],
			"offerType": "ONDEMAND",
			"operatingSystem": "string",
			"productFamily": "string",
			"productId": "string",
			"programOption": "string",
			"purchaseQuantity": 0,
			"region": "string",
			"repriceOption": "YES",
			"retentionPeriod": "string",
			"routeToMarket": "DIRECT",
			"serviceDefinitionId": "string",
			"sku": "string",
			"startDate": "string",
			"supportLevel": "string",
			"tierName": "string"
		}
	],
	"additionalAttributes": {
		"key": "string"
	},
	"billingFrequency": "PREPAID",
	"billingModel": "string",
	"billingTerm": "string",
	"billingTermUom": "MONTHS",
	"categoryId": "string",
	"countryCode": "string",
	"crossRefSku": "string",
	"currency": "string",
	"customerSegment": "ACADEMIC",
	"dataCenter": "string",
	"description": "string",
	"endDate": "string",
	"hostingType": "string",
	"isMandatory": false,
	"licenseQuantity": 0,
	"licenseUnit": "string",
	"licenses": [
		{
			"contactEmail": "string",
			"conversionRatio": 0,
			"conversionRatioUnit": "string",
			"eligibleQuantity": 0,
			"expirationDate": "string",
			"licenseKey": "string",
			"licenseUnit": "string",
			"productDetails": {
				"displayName": "string",
				"product": "string"
			},
			"selectedQuantity": 0,
			"status": "string",
			"totalQuantity": 0
		}
	],
	"name": "string",
	"offerCategory": "PRIMARY",
	"offerConfigGroupId": "string",
	"offerReferenceIds": [
		"string"
	],
	"offerType": "ONDEMAND",
	"operatingSystem": "string",
	"productFamily": "string",
	"productId": "string",
	"programOption": "string",
	"purchaseQuantity": 0,
	"region": "string",
	"repriceOption": "YES",
	"retentionPeriod": "string",
	"routeToMarket": "DIRECT",
	"serviceDefinitionId": "string",
	"sku": "string",
	"startDate": "string",
	"supportLevel": "string",
	"tierName": "string"
}

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

cloud-partner-navigator

Property Of

DistributorSubscriptionDetails
ResellerSubscriptionDetails

CreateOfferRequest

Properties

JSON Example

Property Of

Was this page helpful?