Microsoft.Billing (preview:2017-04-24)

2025/09/26 • 6 new, 6 deleted methods

BillingPeriods_List (new)
Description :  Lists the available billing periods for a subscription in reverse chronological order.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter billing periods by billingPeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: 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. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the most recent N billing periods. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing periods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing period. ,
Required: False ,
}
{
billingPeriodStartDate:
{
Description: The start of the date range covered by the billing period. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodEndDate:
{
Description: The end of the date range covered by the billing period. ,
Format: date ,
Required: False ,
}
string ,
invoiceIds:
{
Description: Array of invoice ids that associated with. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingPeriods_Get (new)
Description :  Gets a named billing period.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: The name of a BillingPeriod resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing period. ,
Required: False ,
}
{
billingPeriodStartDate:
{
Description: The start of the date range covered by the billing period. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodEndDate:
{
Description: The end of the date range covered by the billing period. ,
Format: date ,
Required: False ,
}
string ,
invoiceIds:
{
Description: Array of invoice ids that associated with. ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Invoices_List (new)
Description :  Lists the available invoices for a subscription in reverse chronological order beginning with the most recent invoice. In preview, invoices are available via this API only for invoice periods which end December 1, 2016 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the downloadUrl property within a list of invoices. This enables download links to be generated for multiple invoices at once. By default, downloadURLs are not included when listing invoices. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter invoices by invoicePeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: 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. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the most recent N invoices. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoices. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the invoice. ,
Required: False ,
}
{
downloadUrl:
{
Description: A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached. ,
Required: False ,
}
{
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}
,
invoicePeriodStartDate:
{
Description: The start of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodIds:
{
Description: Array of billing period ids that the invoice is attributed to. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Invoices_Get (new)
Description :  Gets a named invoice resource. When getting a single invoice, the downloadUrl property is expanded automatically.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The name of an invoice resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the invoice. ,
Required: False ,
}
{
downloadUrl:
{
Description: A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached. ,
Required: False ,
}
{
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}
,
invoicePeriodStartDate:
{
Description: The start of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodIds:
{
Description: Array of billing period ids that the invoice is attributed 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Invoices_GetLatest (new)
Description :  Gets the most recent invoice. When getting a single invoice, the downloadUrl property is expanded automatically.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/latest
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the invoice. ,
Required: False ,
}
{
downloadUrl:
{
Description: A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached. ,
Required: False ,
}
{
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}
,
invoicePeriodStartDate:
{
Description: The start of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodIds:
{
Description: Array of billing period ids that the invoice is attributed 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available billing REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/operations
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of billing operations supported by the Microsoft.Billing 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.Billing. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingPeriods_List (removed)
Description :  Lists the available billing periods for a subscription in reverse chronological order.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
$filter:
{
Description: May be used to filter billing periods by billingPeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: 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. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the most recent N billing periods. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing periods. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the billing period. ,
Required: False ,
}
{
billingPeriodStartDate:
{
Description: The start of the date range covered by the billing period. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodEndDate:
{
Description: The end of the date range covered by the billing period. ,
Format: date ,
Required: False ,
}
string ,
invoiceIds:
{
Description: Array of invoice ids that associated with. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
BillingPeriods_Get (removed)
Description :  Gets a named billing period.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
billingPeriodName:
{
Description: The name of a BillingPeriod resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the billing period. ,
Required: False ,
}
{
billingPeriodStartDate:
{
Description: The start of the date range covered by the billing period. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodEndDate:
{
Description: The end of the date range covered by the billing period. ,
Format: date ,
Required: False ,
}
string ,
invoiceIds:
{
Description: Array of invoice ids that associated with. ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Invoices_List (removed)
Description :  Lists the available invoices for a subscription in reverse chronological order beginning with the most recent invoice. In preview, invoices are available via this API only for invoice periods which end December 1, 2016 or later.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the downloadUrl property within a list of invoices. This enables download links to be generated for multiple invoices at once. By default, downloadURLs are not included when listing invoices. ,
Required: False ,
}
string ,
$filter:
{
Description: May be used to filter invoices by invoicePeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. ,
Required: False ,
}
string ,
$skiptoken:
{
Description: 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. ,
Required: False ,
}
string ,
$top:
{
Description: May be used to limit the number of results to the most recent N invoices. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of invoices. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the invoice. ,
Required: False ,
}
{
downloadUrl:
{
Description: A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached. ,
Required: False ,
}
{
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}
,
invoicePeriodStartDate:
{
Description: The start of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodIds:
{
Description: Array of billing period ids that the invoice is attributed to. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Invoices_Get (removed)
Description :  Gets a named invoice resource. When getting a single invoice, the downloadUrl property is expanded automatically.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
invoiceName:
{
Description: The name of an invoice resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the invoice. ,
Required: False ,
}
{
downloadUrl:
{
Description: A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached. ,
Required: False ,
}
{
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}
,
invoicePeriodStartDate:
{
Description: The start of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodIds:
{
Description: Array of billing period ids that the invoice is attributed 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Invoices_GetLatest (removed)
Description :  Gets the most recent invoice. When getting a single invoice, the downloadUrl property is expanded automatically.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/latest
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the invoice. ,
Required: False ,
}
{
downloadUrl:
{
Description: A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached. ,
Required: False ,
}
{
expiryTime:
{
Description: The time in UTC at which this download URL will expire. ,
Format: date-time ,
Required: False ,
}
string ,
url:
{
Description: The URL to the PDF file. ,
Required: False ,
}
string ,
}
,
invoicePeriodStartDate:
{
Description: The start of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
invoicePeriodEndDate:
{
Description: The end of the date range covered by the invoice. ,
Format: date ,
Required: False ,
}
string ,
billingPeriodIds:
{
Description: Array of billing period ids that the invoice is attributed 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available billing REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/operations
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2017-04-24-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of billing operations supported by the Microsoft.Billing 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.Billing. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Invoice, 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}