Price Sheet - Download By Invoice

Service:: Cost Management

API Version:: 2025-03-01

Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

POST https://management.azure.com/providers/microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download?api-version=2025-03-01

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string pattern: ([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}	BillingAccount ID
billingProfileName	path	True	string pattern: ([A-Za-z0-9]+(-[A-Za-z0-9]+)+)	Billing Profile Name.
invoiceName	path	True	string pattern: [A-Za-z0-9]+	The ID that uniquely identifies an invoice.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name

Type

Description

200 OK

The request has succeeded.

202 Accepted

The request has been accepted for processing, but processing has not yet completed.

Headers

Location: string
OData-EntityId: string

Other Status Codes

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

PricesheetDownload

Sample request

HTTP

POST https://management.azure.com/providers/microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/invoices/T000940677/providers/Microsoft.CostManagement/pricesheets/default/download?api-version=2025-03-01

Sample response

Status code:: 200

{
  "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B",
  "expiryTime": "2022-09-30T17:32:28Z"
}

Status code:: 202

Location: https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2025-03-01&OperationType=PriceSheet
OData-EntityId: 45000000-0000-0000-0000-000000000000
Retry-After: 60

Definitions

Name	Description
DownloadURL	The URL to download the generated report.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

DownloadURL

Object

The URL to download the generated report.

Name	Type	Description
downloadUrl	string	The URL to download the generated report.
expiryTime	string (date-time)	The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.
validTill	string (date-time)	The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.

ErrorDetails

Object

The details of the error.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Object

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

Name	Type	Description
error	ErrorDetails	The details of the error.