Microsoft.Billing (stable:2023-11-01)

2025/01/27 • 1 updated methods

PriceSheet_DownloadByBillingProfile (updated)
Description :  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-11-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.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PriceSheet_DownloadByBillingProfile",
  "$responses": {
    "200": {
      "$properties": {
        "downloadFileProperties": [
          {
            "@added_6ce2f536968e4863a7ed1e8d202187a6": {
              "#name": "meterId",
              "Description": "Unique identifier of the meter ",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
billingProfileName:
{
Description: The ID that uniquely identifies a billing profile. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: GET this URL to retrieve the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
string ,
}

⚐ Response (200)

{
expiryTime:
{
Description: The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z. ,
Format: date-time ,
Required: False ,
}
string ,
downloadUrl:
{
Description: The URL to download the generated report. ,
Required: False ,
}
string ,
downloadFileProperties:
{
Description: The properties in downloaded file ,
Required: False ,
}
{
billingAccountID:
{
Description: Unique identifier for the billing account. ,
Required: False ,
}
string ,
billingAccountName:
{
Description: Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: Unique identifier for the billing profile. ,
Required: False ,
}
string ,
billingProfileName:
{
Description: Name of the billing profile that is set up to receive invoices. The prices in the price sheet are associated with this billing profile. ,
Required: False ,
}
string ,
serviceFamily:
{
Description: Type of Azure service. For example, Compute, Analytics, and Security. ,
Required: False ,
}
number ,
product:
{
Description: Name of the product accruing the charges. ,
Required: False ,
}
string ,
productId:
{
Description: Unique identifier for the product whose meter is consumed. ,
Required: False ,
}
string ,
skuId:
{
Description: Unique identifier of the SKU ,
Required: False ,
}
string ,
unitOfMeasure:
{
Description: How usage is measured for the service ,
Required: False ,
}
string ,
meterId:
{
Description: Unique identifier of the meter ,
Required: False ,
}
string ,
meterName:
{
Description: Name of the meter. The meter represents the deployable resource of an Azure service. ,
Required: False ,
}
string ,
meterType:
{
Description: Name of the meter type ,
Required: False ,
}
string ,
meterCategory:
{
Description: Name of the classification category for the meter. For example, Cloud services, Networking, etc. ,
Required: False ,
}
string ,
meterSubCategory:
{
Description: Name of the meter subclassification category. ,
Required: False ,
}
string ,
meterRegion:
{
Description: Name of the Azure region where the meter for the service is available. ,
Required: False ,
}
string ,
tierMinimumUnits:
{
Description: 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. ,
Required: False ,
}
string ,
effectiveStartDate:
{
Description: Effective start date of the Price Sheet billing period ,
Format: date-time ,
Required: False ,
}
string ,
effectiveEndDate:
{
Description: Effective end date of the Price Sheet billing period ,
Format: date-time ,
Required: False ,
}
string ,
unitPrice:
{
Description: 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). ,
Required: False ,
}
string ,
basePrice:
{
Description: 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 ,
Required: False ,
}
string ,
marketPrice:
{
Description: 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. ,
Required: False ,
}
string ,
currency:
{
Description: Currency in which all the prices are reflected. ,
Required: False ,
}
string ,
billingCurrency:
{
Description: Currency in which charges are posted. ,
Required: False ,
}
string ,
term:
{
Description: Term length for Azure Savings Plan or Reservation term – one year or three years (P1Y or P3Y) ,
Required: False ,
}
string ,
priceType:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}