Microsoft.Consumption (preview:2018-11-01)

2025/10/30 • 9 new, 9 deleted methods

Operations_List (new)
Description :  Lists all of the available consumption REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Consumption/operations
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of consumption operations supported by the Microsoft.Consumption resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Consumption. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: UsageDetail, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
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 ,
}
,
}
CreditSummaryByBillingProfile_Get (new)
Description :  The credit summary by billingAccountId and billingProfileId for given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/credits/balanceSummary
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the credit summary. ,
Required: False ,
}
{
balanceSummary:
{
Description: Summary of balances associated with this credit summary. ,
Required: False ,
}
{
estimatedBalance:
{
Description: Estimated balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
currentBalance:
{
Description: Current balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
pendingCreditAdjustments:
{
Description: Pending Credit Adjustments. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
expiredCredit:
{
Description: Expired Credit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pendingEligibleCharges:
{
Description: Pending Eligible Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ 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 ,
}
,
}
EventsByBillingProfile_List (new)
Description :  Lists the events by billingAccountId and billingProfileId for given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/events
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event summary. ,
Required: False ,
}
[
{
properties:
{
Description: The event properties. ,
Required: False ,
}
{
transactionDate:
{
Description: Transaction Date. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Transaction description. ,
Required: False ,
}
string ,
newCredit:
{
Description: New Credit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
adjustments:
{
Description: Credit Adjustments. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditExpired:
{
Description: Credit Expired. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
charges:
{
Description: Credit Eligible Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: Closed Balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
eventType:
{
Description: The type of event. ,
Enum:
{
NewCredit: No description available. ,
ExpiredCredit: No description available. ,
SettledCharges: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceNumber:
{
Description: Invoice Number. ,
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 ,
}
,
}
LotsByBillingProfile_List (new)
Description :  Lists the lots by billingAccountId and billingProfileId for given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/lots
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of lot summary. ,
Required: False ,
}
[
{
properties:
{
Description: The lot properties. ,
Required: False ,
}
{
originalAmount:
{
Description: Original Amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: Closed Balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
source:
{
Description: Lot source. ,
Enum:
{
PurchasedCredit: No description available. ,
PromotionalCredit: No description available. ,
}
,
Required: False ,
}
enum ,
startDate:
{
Description: Start Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration Date. ,
Format: date-time ,
Required: False ,
}
string ,
poNumber:
{
Description: PO Number. ,
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 ,
}
,
}
InvoicePricesheet_Download (new)
Description :  Get pricesheet data for invoice id (invoiceName).
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Consumption/billingAccounts/{billingAccountId}/invoices/{invoiceName}/pricesheet/default/download
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: Azure Billing Account Id. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The name of an invoice resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A secure URL that can be used to download a an entity until the URL expires. ,
Required: False ,
}
{
downloadUrl:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Required: False ,
}
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 ,
azure-asyncoperation:
{
Description: To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
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 ,
}
,
}
BillingProfilePricesheet_Download (new)
Description :  Get pricesheet data for invoice id (invoiceName).
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Consumption/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/pricesheet/default/download
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: Azure Billing Account Id. ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A secure URL that can be used to download a an entity until the URL expires. ,
Required: False ,
}
{
downloadUrl:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Required: False ,
}
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 ,
azure-asyncoperation:
{
Description: To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
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 ,
}
,
}
ChargesByBillingAccount_List (new)
Description :  Lists the charges by billingAccountId for given start and end date. Start and end date are used to determine the billing period. For current month, the data will be provided from month to date. If there are no charges for a month then that month will show all zeroes.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$apply:
{
Description: May be used to group charges by properties/billingProfileId, or properties/invoiceSectionId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary by billing account. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Billing period start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Billing period end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingAccountId:
{
Description: The id of the billing account resource that the charge belongs to. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The id of the billing profile resource that the charge belongs to. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The id of the invoice section resource that the charge belongs to. ,
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 ,
}
,
}
ChargesByBillingProfile_List (new)
Description :  Lists the charges by billing profile id for given start and end date. Start and end date are used to determine the billing period. For current month, the data will be provided from month to date. If there are no charges for a month then that month will show all zeroes.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary by billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Billing period start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Billing period end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingAccountId:
{
Description: The id of the billing account resource that the charge belongs to. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The id of the billing profile resource that the charge belongs to. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The id of the invoice section resource that the charge belongs to. ,
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 ,
}
,
}
ChargesByInvoiceSection_List (new)
Description :  Lists the charges by invoice section id for given start and end date. Start and end date are used to determine the billing period. For current month, the data will be provided from month to date. If there are no charges for a month then that month will show all zeroes.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
invoiceSectionId:
{
Description: Invoice Section Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$apply:
{
Description: May be used to group charges by properties/productName. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary by invoiceSection. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Billing period start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Billing period end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingAccountId:
{
Description: The id of the billing account resource that the charge belongs to. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The id of the billing profile resource that the charge belongs to. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The id of the invoice section resource that the charge belongs to. ,
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 ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available consumption REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Consumption/operations
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of consumption operations supported by the Microsoft.Consumption resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Consumption. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: UsageDetail, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
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 ,
}
,
}
CreditSummaryByBillingProfile_Get (removed)
Description :  The credit summary by billingAccountId and billingProfileId for given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/credits/balanceSummary
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the credit summary. ,
Required: False ,
}
{
balanceSummary:
{
Description: Summary of balances associated with this credit summary. ,
Required: False ,
}
{
estimatedBalance:
{
Description: Estimated balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
currentBalance:
{
Description: Current balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
pendingCreditAdjustments:
{
Description: Pending Credit Adjustments. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
expiredCredit:
{
Description: Expired Credit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
pendingEligibleCharges:
{
Description: Pending Eligible Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
}
,
}

⚐ 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 ,
}
,
}
EventsByBillingProfile_List (removed)
Description :  Lists the events by billingAccountId and billingProfileId for given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/events
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event summary. ,
Required: False ,
}
[
{
properties:
{
Description: The event properties. ,
Required: False ,
}
{
transactionDate:
{
Description: Transaction Date. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Transaction description. ,
Required: False ,
}
string ,
newCredit:
{
Description: New Credit. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
adjustments:
{
Description: Credit Adjustments. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
creditExpired:
{
Description: Credit Expired. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
charges:
{
Description: Credit Eligible Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: Closed Balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
eventType:
{
Description: The type of event. ,
Enum:
{
NewCredit: No description available. ,
ExpiredCredit: No description available. ,
SettledCharges: No description available. ,
}
,
Required: False ,
}
enum ,
invoiceNumber:
{
Description: Invoice Number. ,
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 ,
}
,
}
LotsByBillingProfile_List (removed)
Description :  Lists the lots by billingAccountId and billingProfileId for given start and end date.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/lots
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of lot summary. ,
Required: False ,
}
[
{
properties:
{
Description: The lot properties. ,
Required: False ,
}
{
originalAmount:
{
Description: Original Amount. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
closedBalance:
{
Description: Closed Balance. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
source:
{
Description: Lot source. ,
Enum:
{
PurchasedCredit: No description available. ,
PromotionalCredit: No description available. ,
}
,
Required: False ,
}
enum ,
startDate:
{
Description: Start Date. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDate:
{
Description: Expiration Date. ,
Format: date-time ,
Required: False ,
}
string ,
poNumber:
{
Description: PO Number. ,
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 ,
}
,
}
InvoicePricesheet_Download (removed)
Description :  Get pricesheet data for invoice id (invoiceName).
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Consumption/billingAccounts/{billingAccountId}/invoices/{invoiceName}/pricesheet/default/download
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: Azure Billing Account Id. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The name of an invoice resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A secure URL that can be used to download a an entity until the URL expires. ,
Required: False ,
}
{
downloadUrl:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Required: False ,
}
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 ,
azure-asyncoperation:
{
Description: To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
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 ,
}
,
}
BillingProfilePricesheet_Download (removed)
Description :  Get pricesheet data for invoice id (invoiceName).
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Consumption/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/pricesheet/default/download
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: Azure Billing Account Id. ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Azure Billing Profile Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: A secure URL that can be used to download a an entity until the URL expires. ,
Required: False ,
}
{
downloadUrl:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Required: False ,
}
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 ,
azure-asyncoperation:
{
Description: To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field. ,
}
string ,
odata-entityid:
{
Description: The operation entity Id GUID. ,
}
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 ,
}
,
}
ChargesByBillingAccount_List (removed)
Description :  Lists the charges by billingAccountId for given start and end date. Start and end date are used to determine the billing period. For current month, the data will be provided from month to date. If there are no charges for a month then that month will show all zeroes.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$apply:
{
Description: May be used to group charges by properties/billingProfileId, or properties/invoiceSectionId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary by billing account. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Billing period start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Billing period end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingAccountId:
{
Description: The id of the billing account resource that the charge belongs to. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The id of the billing profile resource that the charge belongs to. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The id of the invoice section resource that the charge belongs to. ,
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 ,
}
,
}
ChargesByBillingProfile_List (removed)
Description :  Lists the charges by billing profile id for given start and end date. Start and end date are used to determine the billing period. For current month, the data will be provided from month to date. If there are no charges for a month then that month will show all zeroes.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
billingProfileId:
{
Description: Billing Profile Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary by billing profile. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Billing period start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Billing period end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingAccountId:
{
Description: The id of the billing account resource that the charge belongs to. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The id of the billing profile resource that the charge belongs to. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The id of the invoice section resource that the charge belongs to. ,
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 ,
}
,
}
ChargesByInvoiceSection_List (removed)
Description :  Lists the charges by invoice section id for given start and end date. Start and end date are used to determine the billing period. For current month, the data will be provided from month to date. If there are no charges for a month then that month will show all zeroes.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/providers/Microsoft.Consumption/charges
{
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
invoiceSectionId:
{
Description: Invoice Section Id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-11-01-preview. ,
Required: True ,
}
string ,
startDate:
{
Description: Start date ,
Required: True ,
}
string ,
endDate:
{
Description: End date ,
Required: True ,
}
string ,
$apply:
{
Description: May be used to group charges by properties/productName. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of charge summary by invoiceSection. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the charge summary. ,
Required: False ,
}
{
billingPeriodId:
{
Description: The id of the billing period resource that the usage belongs to. ,
Required: False ,
}
string ,
usageStart:
{
Description: Billing period start date. ,
Required: False ,
}
string ,
usageEnd:
{
Description: Billing period end date. ,
Required: False ,
}
string ,
azureCharges:
{
Description: Azure Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
chargesBilledSeparately:
{
Description: Charges Billed separately. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
marketplaceCharges:
{
Description: Marketplace Charges. ,
Required: False ,
}
{
currency:
{
Description: The currency for the amount value. ,
Required: False ,
}
string ,
value:
{
Description: Amount value. ,
Required: False ,
}
number ,
}
,
billingAccountId:
{
Description: The id of the billing account resource that the charge belongs to. ,
Required: False ,
}
string ,
billingProfileId:
{
Description: The id of the billing profile resource that the charge belongs to. ,
Required: False ,
}
string ,
invoiceSectionId:
{
Description: The id of the invoice section resource that the charge belongs to. ,
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 ,
}
,
}