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

cloud-partner-navigator

MspSubscriptionDetails

Defines the properties of the Msp Subscription Details.

Properties

map of string

additionalDetails Optional

The addtional details of msp subscriptions.

boolean

amendable Optional

The flag to switch the value of property amendable

string

billingEngineSubscriptionId Optional

The billing engine subscription id in the subscription details.

string

billingFrequency Optional

The billing frequency of msp subscription details.

Possible values are: PREPAID , MONTHLY , ANNUAL

array of ConsolidatedOffer

consolidatedOffers Optional

The list of consolidated offers.

string

currency Optional

The value of currency in an org.

string

endDate Optional

The end date of the subscription.

string

id Optional

The id of the org.

array of BaseOffer

offers Optional

The list of the Base offers.

OrganizationRef

orgRef Optional

Defines the properties of the Organization Ref.

SubscriptionPaymentDetails

payment Optional

Defines the properties of the Subscription Payment Details.

string

renewalPreference Optional

The renewal preference of the subscription details.

Possible values are: MANUAL , AUTO , CANCEL

ServiceRef

serviceRef Optional

Defines the properties of the Service Ref.

string

startDate Optional

The start date of the subscription.

string

status Optional

The msp subscription details status, the value can be ‘SUBMITTED’ ‘CREATED’ ‘ACTIVE’ etc

Possible values are: SUBMITTED , CREATED , ACTIVE , SUSPENDED , CANCELLED , TERMINATED , ERROR , PENDING_EXPIRY , EXPIRED

JSON Example

{
	"additionalDetails": {
		"key": "string"
	},
	"amendable": false,
	"billingEngineSubscriptionId": "string",
	"billingFrequency": "PREPAID",
	"consolidatedOffers": [
		{
			"addOnOffers": [
				{
					"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"
				}
			],
			"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"
		}
	],
	"currency": "string",
	"endDate": "string",
	"id": "string",
	"offers": [
		{
			"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",
			"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
			},
			"offerType": "ONDEMAND",
			"operatingSystem": "string",
			"productId": "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",
			"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"
				}
			]
		}
	],
	"orgRef": {
		"domain": "string",
		"id": "string",
		"name": "string"
	},
	"payment": {
		"contractId": "string"
	},
	"renewalPreference": "MANUAL",
	"serviceRef": {
		"id": "string",
		"name": "string",
		"serviceIcon": "string"
	},
	"startDate": "string",
	"status": "SUBMITTED"
}

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

cloud-partner-navigator

Returned By

Get Subscription By ID

MspSubscriptionDetails

Properties

JSON Example

Returned By

Was this page helpful?