Billing Subscriptions - List By Invoice Section
Lists the subscriptions that are billed to an invoice section. 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}/billingSubscriptions?api-version=2020-05-01
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. |
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
BillingSubscriptionsListByInvoiceSection
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions?api-version=2020-05-01
Sample Response
{
"value": [
{
"id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1",
"name": "billingSubscriptionId1",
"type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
"properties": {
"displayName": "My subscription",
"subscriptionId": "87607149-63a6-4644-8dc1-1d2e368f4994",
"subscriptionBillingStatus": "Active",
"lastMonthCharges": {
"currency": "USD",
"value": 5000
},
"monthToDateCharges": {
"currency": "USD",
"value": 600
},
"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",
"costCenter": "ABC1234",
"skuId": "0001",
"skuDescription": "Microsoft Azure Plan"
}
},
{
"id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2",
"name": "billingSubscriptionId2",
"type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
"properties": {
"displayName": "Test subscription",
"subscriptionId": "87607149-63a6-4644-8dc1-1d2e368f4995",
"subscriptionBillingStatus": "Active",
"lastMonthCharges": {
"currency": "USD",
"value": 1000
},
"monthToDateCharges": {
"currency": "USD",
"value": 400
},
"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",
"costCenter": "ABC1234",
"skuId": "0001",
"skuDescription": "Microsoft Azure Plan"
}
},
{
"id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId3",
"name": "billingSubscriptionId3",
"type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
"properties": {
"displayName": "Dev Subscription",
"subscriptionId": "87607149-63a6-4644-8dc1-1d2e368f4996",
"subscriptionBillingStatus": "Active",
"lastMonthCharges": {
"currency": "USD",
"value": 6000
},
"monthToDateCharges": {
"currency": "USD",
"value": 900
},
"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",
"costCenter": "ABC1234",
"skuId": "0001",
"skuDescription": "Microsoft Azure Plan"
}
}
]
}
Definitions
Name | Description |
---|---|
Amount |
The amount. |
Billing |
A billing subscription. |
Billing |
The list of billing subscriptions. |
Billing |
The current billing status of the subscription. |
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 |
|
Reseller |
Details of the reseller. |
Amount
The amount.
Name | Type | Description |
---|---|---|
currency |
string |
The currency for the amount value. |
value |
number |
Amount value. |
BillingSubscription
A billing subscription.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id. |
name |
string |
Resource name. |
properties.billingProfileDisplayName |
string |
The name of the billing profile to which the subscription is billed. |
properties.billingProfileId |
string |
The ID of the billing profile to which the subscription is billed. |
properties.costCenter |
string |
The cost center applied to the subscription. |
properties.customerDisplayName |
string |
The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. |
properties.customerId |
string |
The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account. |
properties.displayName |
string |
The name of the subscription. |
properties.invoiceSectionDisplayName |
string |
The name of the invoice section to which the subscription is billed. |
properties.invoiceSectionId |
string |
The ID of the invoice section to which the subscription is billed. |
properties.lastMonthCharges |
The last month charges. |
|
properties.monthToDateCharges |
The current month to date charges. |
|
properties.reseller |
Reseller for this subscription. |
|
properties.skuDescription |
string |
The sku description of the Azure plan for the subscription. |
properties.skuId |
string |
The sku ID of the Azure plan for the subscription. |
properties.subscriptionBillingStatus |
The current billing status of the subscription. |
|
properties.subscriptionId |
string |
The ID of the subscription. |
properties.suspensionReasons |
string[] |
The suspension reason for a subscription. Applies only to subscriptions in Microsoft Online Services Program billing accounts. |
type |
string |
Resource type. |
BillingSubscriptionsListResult
The list of billing subscriptions.
Name | Type | Description |
---|---|---|
nextLink |
string |
The link (url) to the next page of results. |
totalCount |
number |
Total number of records. |
value |
The list of billing subscriptions. |
BillingSubscriptionStatusType
The current billing status of the subscription.
Name | Type | Description |
---|---|---|
Abandoned |
string |
|
Active |
string |
|
Deleted |
string |
|
Inactive |
string |
|
Warning |
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. |
Reseller
Details of the reseller.
Name | Type | Description |
---|---|---|
description |
string |
The name of the reseller. |
resellerId |
string |
The MPN ID of the reseller. |