Products - List By Invoice Section
Lists the products for an invoice section. These don't include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products?api-version=2020-05-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products?api-version=2020-05-01&$filter={$filter}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
billing
|
path | True |
string |
The ID that uniquely identifies a billing account. |
billing
|
path | True |
string |
The ID that uniquely identifies a billing profile. |
invoice
|
path | True |
string |
The ID that uniquely identifies an invoice section. |
api-version
|
query | True |
string |
The version of the API to be used with the client request. The current version is 2020-05-01. |
$filter
|
query |
string |
May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:). |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. The request has succeeded. |
|
Other Status Codes |
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
ProductsListByInvoiceSection
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products?api-version=2020-05-01
Sample Response
{
"value": [
{
"id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"type": "Microsoft.Billing/billingAccounts/products",
"properties": {
"autoRenew": "On",
"productTypeId": "A12345",
"productType": "Reservation",
"displayName": "Eng Reservation (1a13s21awe)",
"status": "Active",
"purchaseDate": "2018-05-01T17:32:28Z",
"lastCharge": {
"currency": "USD",
"value": 5000
},
"lastChargeDate": "2018-06-15T17:32:28Z",
"billingFrequency": "OneTime",
"quantity": 4,
"skuId": "0001",
"skuDescription": "Enterprise Agreement Development",
"tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce",
"availabilityId": "AvailabilityId1",
"invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
"invoiceSectionDisplayName": "Contoso operations invoiceSection",
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
"billingProfileDisplayName": "Contoso operations billing"
}
},
{
"id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001",
"name": "10000000-0000-0000-0000-000000000001",
"type": "Microsoft.Billing/billingAccounts/products",
"properties": {
"autoRenew": "On",
"productTypeId": "A12345",
"productType": "Azure subscription",
"displayName": "Engineering Email",
"status": "Active",
"purchaseDate": "2018-04-01T17:32:28Z",
"lastCharge": {
"currency": "USD",
"value": 500
},
"lastChargeDate": "2018-06-15T17:32:28Z",
"billingFrequency": "Monthly",
"quantity": 4,
"skuId": "0001",
"skuDescription": "Enterprise Agreement Development",
"availabilityId": "AvailabilityId1",
"invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
"invoiceSectionDisplayName": "Contoso operations invoiceSection",
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
"billingProfileDisplayName": "Contoso operations billing"
}
}
],
"totalCount": 2
}
Definitions
Name | Description |
---|---|
Amount |
The amount. |
Auto |
Indicates whether auto renewal is turned on or off for a product. |
Billing |
The frequency at which the product will be billed. |
Error |
The details of the error. |
Error |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. |
Error |
|
Product |
A product. |
Products |
The list of products. It contains a list of available product summaries in reverse chronological order by purchase date. |
Product |
The current status of the product. |
Reseller |
Details of the reseller. |
Amount
The amount.
Name | Type | Description |
---|---|---|
currency |
string |
The currency for the amount value. |
value |
number |
Amount value. |
AutoRenew
Indicates whether auto renewal is turned on or off for a product.
Name | Type | Description |
---|---|---|
Off |
string |
|
On |
string |
BillingFrequency
The frequency at which the product will be billed.
Name | Type | Description |
---|---|---|
Monthly |
string |
|
OneTime |
string |
|
UsageBased |
string |
ErrorDetails
The details of the error.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
details |
The sub details of the error. |
|
message |
string |
Error message indicating why the operation failed. |
target |
string |
The target of the particular error. |
ErrorResponse
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Name | Type | Description |
---|---|---|
error |
The details of the error. |
ErrorSubDetails
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
message |
string |
Error message indicating why the operation failed. |
target |
string |
The target of the particular error. |
Product
A product.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id. |
name |
string |
Resource name. |
properties.autoRenew |
Indicates whether auto renewal is turned on or off for a product. |
|
properties.availabilityId |
string |
The availability of the product. |
properties.billingFrequency |
The frequency at which the product will be billed. |
|
properties.billingProfileDisplayName |
string |
The name of the billing profile to which the product is billed. |
properties.billingProfileId |
string |
The ID of the billing profile to which the product is billed. |
properties.customerDisplayName |
string |
The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. |
properties.customerId |
string |
The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account. |
properties.displayName |
string |
The display name of the product. |
properties.endDate |
string |
The date when the product will be renewed or canceled. |
properties.invoiceSectionDisplayName |
string |
The name of the invoice section to which the product is billed. |
properties.invoiceSectionId |
string |
The ID of the invoice section to which the product is billed. |
properties.lastCharge |
The last month charges. |
|
properties.lastChargeDate |
string |
The date of the last charge. |
properties.productType |
string |
The description of the type of product. |
properties.productTypeId |
string |
The ID of the type of product. |
properties.purchaseDate |
string |
The date when the product was purchased. |
properties.quantity |
number |
The quantity purchased for the product. |
properties.reseller |
Reseller for this product. |
|
properties.skuDescription |
string |
The sku description of the product. |
properties.skuId |
string |
The sku ID of the product. |
properties.status |
The current status of the product. |
|
properties.tenantId |
string |
The id of the tenant in which the product is used. |
type |
string |
Resource type. |
ProductsListResult
The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link (url) to the next page of results. |
totalCount |
number |
Total number of records. |
value |
Product[] |
The list of products. |
ProductStatusType
The current status of the product.
Name | Type | Description |
---|---|---|
Active |
string |
|
AutoRenew |
string |
|
Cancelled |
string |
|
Disabled |
string |
|
Expired |
string |
|
Expiring |
string |
|
Inactive |
string |
|
PastDue |
string |
Reseller
Details of the reseller.
Name | Type | Description |
---|---|---|
description |
string |
The name of the reseller. |
resellerId |
string |
The MPN ID of the reseller. |