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

ResellerSubscriptionDetails

Details of a subscription of a reseller


Properties

boolean
amendable Optional

flag to indicate if the subscription is amendable


string
billingEngineDiscountContractId Optional

attribute to indicate billing engine discount contractId.


string
billingEngineSubscriptionId Optional

The underlying billing engine subscription ID


string
billingFrequency Optional

Billing frequency of the offer

Possible values are: PREPAIDMONTHLYANNUAL


consolidatedOffers Optional

List of consolidated offers coming under the subscription


string
currency Optional

ISO Currency 3 letter code for subscription currency


customerRef Optional

Reference object containing minimal details of a customer


string
discountContractId Optional

attribute to indicate discount contractId.


string
endDate Optional

End Date of the Subscription


string
id Optional

Subscription ID coming from CSP


boolean
multiplePartnersTransacted Optional

attribute to indicate the subscription is transacted by multiple partners.


array of OfferGroup
offerGroups Optional

List of all offer groups coming under the subscription


array of Offer
offers Optional

List of all offers coming under the subscription


orderSource Optional

Response Model for Subscription Order Source


organizationRef Optional

Reference object containing minimal details of organization.


string
paymentType Optional

Type of payment method used for purchase

Possible values are: FUNDCREDIT_CARDCOMMIT_CONTRACTPAY_BY_INVOICE_ACCOUNTCOMMIT_AGGREGATE


string
renewalPreference Optional

Renewal preference of a subscription

Possible values are: MANUALAUTOCANCELNOT_SELECTED


array of ServiceRef
serviceRefs Optional

Minimal Details of the services activated under the Subscription


string
startDate Optional

Start Date of the Subscription


string
status Optional

Current Status of a subscription

Possible values are: SUBMITTEDCREATEDACTIVESUSPENDEDCANCELLEDTERMINATEDERRORPENDING_EXPIRYEXPIRED


string
subscriptionType Optional

Type of subscription. Could be COMMIT/ONDEMAND

Possible values are: COMMITONDEMAND


string
totalListPrice Optional

The total list price (MSRP) at this grouping level. (in offers this same as unit but for subscription this is defined as purchaseQuantity * unitListPrice)


number as double
totalNetPrice Optional

totalNetAmount = totalSalePrice+totalPromotionSavings+totalCreditSavings+totalTaxes. The sum of the total net amount at this grouping level


number as double
totalRenewalNetPrice Optional

Total Renewal Net Price for the subscription

JSON Example

{
	"amendable": false,
	"billingEngineDiscountContractId": "string",
	"billingEngineSubscriptionId": "string",
	"billingFrequency": "PREPAID",
	"consolidatedOffers": [
		{
			"addOnOffers": [
				{
					"additionalAttributes": {
						"key": "string"
					},
					"billingFrequency": "PREPAID",
					"billingModel": "string",
					"billingTerm": "string",
					"billingTermUom": "MONTHS",
					"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",
					"productId": "string",
					"programOption": "string",
					"purchaseQuantity": 0,
					"region": "string",
					"repriceOption": "YES",
					"retentionPeriod": "string",
					"routeToMarket": "DIRECT",
					"startDate": "string",
					"supportLevel": "string",
					"tierName": "string"
				}
			],
			"additionalAttributes": {
				"key": "string"
			},
			"billingFrequency": "PREPAID",
			"billingModel": "string",
			"billingTerm": "string",
			"billingTermUom": "MONTHS",
			"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",
			"productId": "string",
			"programOption": "string",
			"purchaseQuantity": 0,
			"region": "string",
			"repriceOption": "YES",
			"retentionPeriod": "string",
			"routeToMarket": "DIRECT",
			"startDate": "string",
			"supportLevel": "string",
			"tierName": "string"
		}
	],
	"currency": "string",
	"customerRef": {
		"name": "string",
		"orgId": "string",
		"orgName": "string",
		"uuid": "string"
	},
	"discountContractId": "string",
	"endDate": "string",
	"id": "string",
	"multiplePartnersTransacted": false,
	"offerGroups": [
		{
			"billingFrequency": "PREPAID",
			"billingTerm": 0,
			"billingTermUom": "string",
			"crossRefSku": "string",
			"currency": "string",
			"description": "string",
			"endDate": "string",
			"id": "string",
			"name": "string",
			"offerCategory": "PRIMARY",
			"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",
			"offers": [
				{
					"additionalAttributes": {
						"key": "string"
					},
					"billingFrequency": "PREPAID",
					"billingModel": "COMMIT_REQUIRED",
					"crossRefSku": "string",
					"currency": "string",
					"description": "string",
					"discountSavings": [
						{
							"attributes": {},
							"discountAmount": 0,
							"type": "RCD"
						}
					],
					"endDate": "string",
					"licenseUnit": "string",
					"listPrice": 0,
					"name": "string",
					"netPrice": 0,
					"offerCategory": "PRIMARY",
					"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",
					"programOption": "string",
					"purchaseQuantity": 0,
					"quantityUom": "string",
					"referenceId": "string",
					"serviceRef": {
						"id": "string",
						"name": "string",
						"serviceIcon": "string"
					},
					"startDate": "string",
					"status": "SUBMITTED",
					"tierName": "string",
					"unitListPrice": 0,
					"unitNetPrice": 0,
					"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",
					"volumeTierDiscount": 0
				}
			],
			"productId": "string",
			"purchaseQuantity": 0,
			"quantityUom": "string",
			"routeToMarket": "string",
			"startDate": "string",
			"status": "SUBMITTED"
		}
	],
	"offers": [
		{
			"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"
		}
	],
	"orderSource": {
		"displayName": "string",
		"orderId": "string",
		"source": "MPCB",
		"sourceId": "string",
		"type": "MARKETPLACE_2T"
	},
	"organizationRef": {
		"id": "string",
		"name": "string"
	},
	"paymentType": "FUND",
	"renewalPreference": "MANUAL",
	"serviceRefs": [
		{
			"id": "string",
			"name": "string",
			"serviceIcon": "string"
		}
	],
	"startDate": "string",
	"status": "SUBMITTED",
	"subscriptionType": "COMMIT",
	"totalListPrice": "string",
	"totalNetPrice": 0,
	"totalRenewalNetPrice": 0
}
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Returned By

Get Reseller Subscription Details

Feedback

Was this page helpful?