Share via


Azure spending - Get customer usage summary

Retrieves the usage summary for a customer.

GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/usagesummary

URI Parameters

Name In Required Type Description
customer_id
path True

string

The customer id.

Request Header

Name Required Type Description
Authorization True

string

Authorization Bearer token

ms-correlationid

string

Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request

ms-cv

string

Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request

ms-requestid

string

Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name Type Description
200 OK

UsageManagement.CustomerUsageSummary

The request was successful. The response body contains the usage summary.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

400 Bad Request

There was a missing or an invalid input. The response body will provide the error details.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

401 Unauthorized

The request was not authenticated. The client needs to authenticate with the partner API service first.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

403 Forbidden

The request was authenticated but was refused since the caller does not have the rights to invoke it.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

404 Not Found

The resource is not found or not available with the given input parameters.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

500 Internal Server Error

The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name Description
Link
ResourceAttributes
ResourceLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]
UsageManagement.CustomerUsageSummary
UsageManagement.SpendingBudget
Name Type Description
headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

ResourceAttributes

Name Type Description
etag

string

objectType

string

Name Type Description
next

Link

previous

Link

self

Link

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name Type Description
key

string

value

string

UsageManagement.CustomerUsageSummary

Name Type Description
attributes

ResourceAttributes

billingEndDate

string (date-time)

billingStartDate

string (date-time)

budget

UsageManagement.SpendingBudget

currencyCode

string

currencyLocale

string

customerSpendingBudget

UsageManagement.SpendingBudget

id

string

lastModifiedDate

string (date-time)

links

ResourceLinks

name

string

resourceId

string

resourceName

string

spendingBudget

number (double)

totalCost

number (double)

usdTotalCost

number (double)

UsageManagement.SpendingBudget

Name Type Description
amount

number (double)

attributes

ResourceAttributes

usageSpendingBudget

number (double)