Price Sheet - Download By Billing Account Period

  • Reference
Service:
Consumption
API Version:
2024-08-01

Generates the pricesheet for the provided billing period asynchronously based on the enrollment id

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/pricesheets/download?api-version=2024-08-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

Request processing completed.
202 Accepted

Accepted

Headers

  • Location: string
  • Retry-After: integer
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

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/0000000/billingPeriods/202305/providers/Microsoft.Consumption/pricesheets/download?api-version=2024-08-01

Sample response

Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/0000000/providers/Microsoft.Consumption/operationResults/00000000-0000-0000-0000-000000000000?api-version=2023-03-01
Retry-After: 10
Status code:
200 
{
  "status": "Completed",
  "properties": {
    "downloadUrl": "https://xxxxxx.blob.core.windows.net/armpricesheetreportdownloadcontainer/20230510/00000000-0000-0000-0000-000000000000",
    "validTill": "2023-05-11T05:12:50.4266333Z"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
OperationStatus

The status of the long running operation.
OperationStatusType

The status of the long running operation.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

OperationStatus

The status of the long running operation.

Name Type Description
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