Price Sheet - Get

Reference

Service:: Consumption

API Version:: 2024-08-01

Gets the price sheet for a subscription. Price sheet is available via this API only for May 1, 2014 or later.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default?api-version=2024-08-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default?$expand={$expand}&$skiptoken={$skiptoken}&$top={$top}&api-version=2024-08-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. The current version is 2023-03-01.
$expand	query		string	May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.
$skiptoken	query		string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
$top	query		integer (int32) minimum: 1 maximum: 1000	May be used to limit the number of results to the top N results.

Responses

Name	Type	Description
200 OK	PriceSheetResult	OK. The request has succeeded.
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

PriceSheet

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/pricesheets/default?api-version=2024-08-01

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/pricesheets/default",
  "name": "default",
  "type": "Microsoft.Consumption/pricesheets",
  "properties": {
    "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/microsoft.consumption/pricesheets/default?api-version=2018-01-31&$skiptoken=AQAAAA%3D%3D",
    "pricesheets": [
      {
        "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "unitOfMeasure": "100 Hours",
        "includedQuantity": 100,
        "partNumber": "XX-11110",
        "unitPrice": 0.00328,
        "currencyCode": "EUR",
        "offerId": "OfferId 1",
        "savingsPlan": {
          "term": "P3Y",
          "effectivePrice": 0.002,
          "marketPrice": 0.00328
        }
      }
    ]
  }
}

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. 504 Gateway Timeout - Service timed out while processing the request. Reduce the date range in the request, if possible.
MeterDetails	The properties of the meter detail.
PriceSheetProperties	The properties of the price sheet.
PriceSheetResult	An pricesheet resource.
SavingsPlan	The properties of the SavingsPlan.

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.

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.
504 Gateway Timeout - Service timed out while processing the request. Reduce the date range in the request, if possible.

Name	Type	Description
error	ErrorDetails	The details of the error.

MeterDetails

Object

The properties of the meter detail.

Name	Type	Description
meterCategory	string	The category of the meter, for example, 'Cloud services', 'Networking', etc..
meterLocation	string	The location in which the Azure service is available.
meterName	string	The name of the meter, within the given meter category
meterSubCategory	string	The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..
pretaxStandardRate	number (decimal)	The pretax listing price.
serviceName	string	The name of the service.
serviceTier	string	The service tier.
totalIncludedQuantity	number (decimal)	The total included quantity associated with the offer.
unit	string	The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.

PriceSheetProperties

Object

The properties of the price sheet.

Name	Type	Description
billingPeriodId	string	The id of the billing period resource that the usage belongs to.
currencyCode	string	Currency Code
includedQuantity	number (decimal)	Included quality for an offer
meterDetails	MeterDetails	The details about the meter. By default this is not populated, unless it's specified in $expand.
meterId	string (uuid)	The meter id (GUID)
offerId	string	Offer Id
partNumber	string	Part Number
savingsPlan	SavingsPlan	SavingsPlan Details
unitOfMeasure	string	Unit of measure
unitPrice	number (decimal)	Unit Price

PriceSheetResult

Object

An pricesheet resource.

Name	Type	Description
etag	string	The etag for the resource.
id	string	The full qualified ARM ID of an event.
name	string	The ID that uniquely identifies an event.
properties.download	MeterDetails	Pricesheet download details.
properties.nextLink	string	The link (url) to the next page of results.
properties.pricesheets	PriceSheetProperties[]	Price sheet
tags	object	Resource tags.
type	string	Resource type.

SavingsPlan

Object

The properties of the SavingsPlan.

Name	Type	Description
effectivePrice	number (decimal)	SavingsPlan Effective Price
marketPrice	number (decimal)	SavingsPlan Market Price
term	string	SavingsPlan term

Share via

Price Sheet - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

PriceSheet

Sample request

Sample response

Definitions

ErrorDetails

ErrorResponse

MeterDetails

PriceSheetProperties

PriceSheetResult

SavingsPlan