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

Get Distributor Discount Contract Details

Description

Retrieves data about a specified discount contract within a Distributor organization.

Request

Request

URL

URL


get
https://{api_host}/distributors/{orgId}/discount-contracts/{billingEngineDiscountContractId}
Copy

Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP


string
billingEngineDiscountContractId Required

Billing Engine Discount Contract ID


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DistributorDiscountContractDetails of type application/json
{
	"billingEngineDiscountContractId": "CBCID-001",
	"commitmentBreakup": {
		"currentYear": {
			"commitment": 150.8,
			"endDate": "1/20/2021",
			"overage": 0,
			"remaining": 30.3,
			"spent": 120.5,
			"startDate": "1/20/2020"
		},
		"term": [
			{
				"commitment": 150.8,
				"endDate": "1/20/2021",
				"overage": 0,
				"rank": 0,
				"remaining": 30.3,
				"spent": 120.5,
				"spentPercent": 0,
				"startDate": "1/20/2020"
			}
		],
		"totalYears": {
			"commitment": 150.8,
			"endDate": "1/20/2021",
			"overage": 0,
			"remaining": 30.3,
			"spent": 120.5,
			"spentPercent": 0,
			"startDate": "1/20/2020"
		}
	},
	"discountContractTypeRef": {
		"contractType": "VMC",
		"contractTypeIcon": "string",
		"currency": "USD",
		"discountContractCustomerRef": {
			"cspOrgId": "ORG1",
			"cspOrgName": "Coke Org",
			"customerName": "Coke",
			"customerUuid": "CUST-123",
			"sfdcAccountId": "123456"
		},
		"endDate": "1/20/2021",
		"startDate": "1/20/2020"
	},
	"discountDetails": {
		"cabDiscountPercentage": 10.2,
		"cabValue": 10000,
		"channelDiscountPercentage": 0.5
	},
	"rcdDiscount": [
		{
			"groupCode": "G003",
			"percent": 0
		}
	],
	"resellerRef": {
		"name": "Soft Choice",
		"orgId": "234-134-1234-12334",
		"partnerId": "112341234"
	},
	"status": "ACTIVE"
}
string
billingEngineDiscountContractId Optional

Billing Engine Discount Contract ID


commitmentBreakup Optional

Commitment breakup of Billing Engine Discount Contract


string
currency Optional

Currency of Billing Engine Discount Contract


discountContractCustomerRef Optional

Customer information for Billing Engine Discount Contract


discountContractTypeRef Optional

Type of Billing Engine Discount Contract such as VMC or VMC-U


discountDetails Optional

Details about CAB discount percent, cab value and channelDiscountPercentage


string
endDate Optional

Commitment end date of Billing Engine Discount Contract


boolean
hasSubscriptions Optional

Indicates whether or not subscriptions are created against this discount contract Id


array of DiscountGroup
rcdDiscount Optional

Discount Groups linked with the contract


resellerRef Optional

Reference object containing minimal details of a reseller


string
startDate Optional

Commitment start date of Billing Engine Discount Contract


string
status Optional

Status of Billing Engine Discount Contract

Possible values are: ACTIVEINACTIVE

Errors

Errors

ErrorResponse
400

Bad Request - The request is either incomplete or incorrect


ErrorResponse
401

Unauthorized - The request requires user authentication


ErrorResponse
403

Forbidden - User does not have permission for this operation


ErrorResponse
404

Not Found - The requested resource does not exist


ErrorResponse
500

Internal Server Error - Please contact support

Code Samples

Code Samples

cURL Command

curl https://{api_host}/distributors/{orgId}/discount-contracts/{billingEngineDiscountContractId}


Feedback

Was this page helpful?