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

Get Distributor Usages

Description

For a specified distributor organization, retrieves details about the usage summaries of all Reseller customers with active discount contracts.

  • Default Filter: USAGE_DATE BETWEEN (Previous Quarter)
  • Default Sorting Order: USAGE_DATE (Descending)

Request

Request

URL

URL


post
https://{api_host}/distributors/{orgId}/usages/search
Copy

Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP


Query Parameters

Query Parameters

integer
pageLimit Optional

Number of results to be fetched per page


integer
pageStart Optional

Result number to be first on the page


Request Body

Request Body

DistributorUsageSummaryRequest of mimetype application/json Optional

Usages summary filters for Distributor

{
	"filters": [
		{
			"key": "CHARGE_ID",
			"operator": "EQUALS",
			"value": "VOD-HS"
		}
	]
}
array of object
filters Optional

A list of filters for usage summary list for Distributor

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns UsagePage of type application/json
{
	"current": 1,
	"next": 3,
	"results": [
		{
			"billingEngineDiscountContractId": "12345",
			"chargeDescription": "VMware Cloud on AWS - Elastic IP address",
			"chargeId": "VOD-IP-A1",
			"commitment": 0,
			"customerName": "PotlatchDeltic",
			"customerOrgId": "bce80100-cc4f-45e0-8a79-5063de5ba191",
			"dataCenterDescription": "US West (Oregon)",
			"distributorId": "1284310",
			"distributorName": "Carahsoft Technology Corporation",
			"msrpPrice": 8.368063,
			"onDemandUsage": 3666,
			"partNumber": "COA-12MT0-AU",
			"productFamily": "VMC-AWS",
			"resellerId": "114214",
			"resellerName": "SoftChoice Inc",
			"service": "VMware Cloud on AWS",
			"subscriptionId": "M1627786076",
			"unitOfMeasurement": "IP",
			"usage": 3666,
			"usageTimestamp": "2021-11-11 00:00:00"
		}
	],
	"totalResultsCount": 100
}
integer as int32
current Optional

First result on the current page


integer as int32
next Optional

First result on the next page


array of UsageSummary
results Optional

Paginated result of usage summary


integer as int32
totalResultsCount Optional

The total number of results

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 -X POST -H "Content-Type: application/json" -d '{"filters":[{"key":"CHARGE_ID","operator":"EQUALS","value":"VOD-HS"}]}' https://{api_host}/distributors/{orgId}/usages/search


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

Was this page helpful?