Manage billing - Get a customer's service costs summary

Retrieves the service costs incurred by the customer's subscriptions.

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

URI Parameters

Name In Required Type Description
billing_period
path True

string

The billing period for which the service costs are being queried for. Currently only "MostRecent" is supported.

customer_id
path True

string

The customer tenant 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

ServiceCostsSummary

The request was successful. The response body contains the requested customer service costs.

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
Collections.Link
Collections.ResourceAttributes
Collections.ResourceLinks
ServiceCostsSummary
ServiceCostsSummaryDetail
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name Type Description
body

string

headers

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

method

string

uri

string

Collections.ResourceAttributes

Name Type Description
etag

string

objectType

string

Name Type Description
next

Collections.Link

previous

Collections.Link

self

Collections.Link

ServiceCostsSummary

Name Type Description
afterTaxTotal

number

attributes

Collections.ResourceAttributes

billingEndDate

string

billingStartDate

string

currencyCode

string

currencySymbol

string

customerId

string

details

ServiceCostsSummaryDetail[]

links

Collections.ResourceLinks

pretaxTotal

number

tax

number

ServiceCostsSummaryDetail

Name Type Description
invoiceType

string

summary

ServiceCostsSummary

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

Name Type Description
key

string

value

string