Price Sheet - Download By Billing Account

Service:

Cost Management

API Version:

2023-11-01

Generates the pricesheet for the provided billing period asynchronously based on the Enrollment ID. This is for Enterprise Agreement customers. You can use the new 2023-09-01 API version at '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download' for billing periods January 2023 onwards. With a new schema detailed below, the new price sheet provides more information and includes prices for Azure Reserved Instances (RI) for the current billing period.

We recommend downloading an Azure Price Sheet for when entering a new billing period if you would maintain a record of past Azure Reserved Instance (RI) pricing. Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single .csv file to a zip file containing multiple csv files, each with max size of 75MB.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.CostManagement/pricesheets/default/download?api-version=2023-11-01

URI Parameters

Name	In	Required	Type	Description
billingAccountId	path	True	string	BillingAccount ID
billingPeriodName	path	True	string	Billing Period Name. Regex pattern: ^[0-9]*$
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	OperationStatus	OK. The request has succeeded.
202 Accepted		Accepted. Headers Location: string Retry-After: string
Other Status Codes	ErrorResponse	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

EAPriceSheetForBillingPeriod

Sample Request

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/0000000/billingPeriods/202311/providers/Microsoft.CostManagement/pricesheets/default/download?api-version=2023-11-01

Sample Response

Status code:

202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/0000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-09-01
Retry-After: 60

Status code:

200

{
  "status": "Completed",
  "properties": {
    "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",
    "validTill": "2023-09-30T17:32:28Z"
  }
}

Definitions

Name	Description
EAPriceSheetProperties	The properties of the EA price sheet.
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.
OperationStatus	The status of the long running operation.
OperationStatusType	The status of the long running operation.

EAPriceSheetProperties

The properties of the EA 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
currencyCode	string	Currency in which the Enterprise Agreement was signed
effectiveEndDate	string	Effective end date of the Price Sheet billing period
effectiveStartDate	string	Effective start date of the Price Sheet billing period
enrollmentNumber	string	Unique identifier for the EA billing account.
includedQuantity	string	Quantities of a specific service to which an EA customer is entitled to consume without incremental charges.
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. Note: For EA customers with no negotiations, market price may appear rounded to a different decimal precision than unit price.
meterCategory	string	Name of the classification category for the meter. For example, Cloud services, Networking, etc.
meterId	string	Unique identifier of the meter
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
partNumber	string	Part number associated with the meter
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.
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)
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).

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.

OperationStatus

The status of the long running operation.

Name	Type	Description
properties.downloadFileProperties	EAPriceSheetProperties	The properties in downloaded file
properties.downloadUrl	string	The link (url) to download the pricesheet.
properties.validTill	string	Download link validity.
status	OperationStatusType	The status of the long running operation.

OperationStatusType

The status of the long running operation.

Name	Type	Description
Completed	string
Failed	string
Running	string