Price Sheet - Get
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
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default?$expand={$expand}&$skiptoken={$skiptoken}&$top={$top}&api-version=2024-08-01
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
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 |
May be used to limit the number of results to the top N results. |
Name | Type | Description |
---|---|---|
200 OK |
OK. The request has succeeded. |
|
Other Status Codes |
Error response describing why the operation failed. |
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/pricesheets/default?api-version=2024-08-01
Sample response
{
"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
}
}
]
}
}
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Meter |
The details about the meter. By default this is not populated, unless it's specified in $expand. |
Price |
Price sheet |
Price |
An pricesheet resource. |
Savings |
SavingsPlan Details |
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
The details about the meter. By default this is not populated, unless it's specified in $expand.
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 |
The pretax listing price. |
serviceName |
string |
The name of the service. |
serviceTier |
string |
The service tier. |
totalIncludedQuantity |
number |
The total included quantity associated with the offer. |
unit |
string |
The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. |
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 |
Included quality for an offer |
meterDetails |
The details about the meter. By default this is not populated, unless it's specified in $expand. |
|
meterId |
string |
The meter id (GUID) |
offerId |
string |
Offer Id |
partNumber |
string |
Part Number |
savingsPlan |
SavingsPlan Details |
|
unitOfMeasure |
string |
Unit of measure |
unitPrice |
number |
Unit Price |
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 |
Pricesheet download details. |
|
properties.nextLink |
string |
The link (url) to the next page of results. |
properties.pricesheets |
Price sheet |
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
SavingsPlan Details
Name | Type | Description |
---|---|---|
effectivePrice |
number |
SavingsPlan Effective Price |
marketPrice |
number |
SavingsPlan Market Price |
term |
string |
SavingsPlan term |