Price Sheet - Download By Billing Profile

Reference

Service:: Cost Management

API Version:: 2024-08-01

Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.

You can use the new 2023-09-01 API version for billing periods January 2023 onwards. Azure Reserved Instance (RI) pricing is only available through the new version of the API.

Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single csv/json file to a Zip file containing multiple csv/json files, each with max size of 75MB.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download?api-version=2024-08-01

URI Parameters

Name In Required Type Description

billingAccountName

path

True

string

The ID that uniquely identifies a billing account.

Regex 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}

billingProfileName

path

True

string

The ID that uniquely identifies a billing profile.

Regex pattern: ([A-Za-z0-9]+(-[A-Za-z0-9]+)+)

api-version

query

True

string

The API version to use for this operation.

Responses

Name

Type

Description

200 OK

PricesheetDownloadProperties

OK. The request has succeeded.

202 Accepted

Accepted.

Headers

Location: string
Retry-After: string
OData-EntityId: string

Other Status Codes

Error response describing why the operation failed.

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

PricesheetDownloadByBillingProfile

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/providers/Microsoft.CostManagement/pricesheets/default/download?api-version=2024-08-01

Sample response

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=2024-08-01&OperationType=PriceSheet
Retry-After: 60
OData-EntityId: 45000000-0000-0000-0000-000000000000

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": "2018-07-21T17:32:28Z"
}

Definitions

Name	Description
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. Some Error responses: 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
MCAPriceSheetProperties	The properties of the price sheet.
PricesheetDownloadProperties	The URL to download the generated report.

ErrorDetails

The details of the error.

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

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Some Error responses:

429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.
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.

MCAPriceSheetProperties

The properties of the price sheet.

Name	Type	Description
basePrice	string	The unit price at the time the customer signs on or the unit price at the time of service meter GA launch if it is after sign-on. This is applicable for Enterprise Agreement users
billingAccountID	string	Unique identifier for the billing account.
billingAccountName	string	Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile.
billingCurrency	string	Currency in which charges are posted.
billingProfileId	string	Unique identifier for the billing profile.
billingProfileName	string	Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile.
currency	string	Currency in which all the prices are reflected.
effectiveEndDate	string	Effective end date of the Price Sheet billing period
effectiveStartDate	string	Effective start date of the Price Sheet billing period
marketPrice	string	The current list price for a given product or service. This price is without any negotiations and is based on your Microsoft Agreement type. For PriceType Consumption, market price is reflected as the pay-as-you-go price. For PriceType Savings Plan, market price reflects the Savings plan benefit on top of pay-as-you-go price for the corresponding commitment term. For PriceType ReservedInstance, market price reflects the total price of the 1 or 3-year commitment.
meterCategory	string	Name of the classification category for the meter. For example, Cloud services, Networking, etc.
meterName	string	Name of the meter. The meter represents the deployable resource of an Azure service.
meterRegion	string	Name of the Azure region where the meter for the service is available.
meterSubCategory	string	Name of the meter subclassification category.
meterType	string	Name of the meter type
priceType	string	Price type for a product. For example, an Azure resource with a pay-as-you-go rate with priceType as Consumption. Other price types include ReservedInstance and Savings Plan.
product	string	Name of the product accruing the charges.
productId	string	Unique identifier for the product whose meter is consumed.
productOrderName	string	Name of the purchased product plan. Indicates if this pricing is standard Azure Plan pricing, Dev/Test pricing etc. Currently unavailable for Azure 3rd party and ReservedInstance meters.
serviceFamily	number	Type of Azure service. For example, Compute, Analytics, and Security.
skuId	string	Unique identifier of the SKU
term	string	Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y)
tierMinimumUnits	string	Defines the lower bound of the tier range for which prices are defined. For example, if the range is 0 to 100, tierMinimumUnits would be 0.
unitOfMeasure	string	How usage is measured for the service
unitPrice	string	The per-unit price at the time of billing for a given product or service, inclusive of any negotiated discounts on top of the market price. For PriceType ReservedInstance, unit price reflects the total cost of the 1 or 3-year commitment including discounts. Note: The unit price isn't the same as the effective price in usage details downloads when services have differential prices across tiers. If services have multi-tiered pricing, the effective price is a blended rate across the tiers and doesn't show a tier-specific unit price. The blended price or effective price is the net price for the consumed quantity spanning across the multiple tiers (where each tier has a specific unit price).

PricesheetDownloadProperties

The URL to download the generated report.

Name	Type	Description
downloadFileProperties	MCAPriceSheetProperties	The properties in downloaded file
downloadUrl	string	The URL to download the generated report.
expiryTime	string	The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.