Billing Subscriptions - List By Billing Account

Service:

Billing

API Version:

2024-04-01

Lists the subscriptions for a billing account.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions?api-version=2024-04-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions?includeDeleted={includeDeleted}&includeTenantSubscriptions={includeTenantSubscriptions}&includeFailed={includeFailed}&api-version=2024-04-01&expand={expand}&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string	The ID that uniquely identifies a billing account.
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2024-04-01.
count	query		boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response.
expand	query		string	Can be used to expand Reseller, ConsumptionCostCenter, LastMonthCharges and MonthToDateCharges
filter	query		string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
includeDeleted	query		boolean	Can be used to get deleted billing subscriptions.
includeFailed	query		boolean	Can be used to get failed billing subscriptions.
includeTenantSubscriptions	query		boolean	Can be used to get tenant-owned billing subscriptions. This field is only applies to Microsoft Online Services Program billing accounts.
orderBy	query		string	The orderby query option allows clients to request resources in a particular order.
search	query		string	The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.
skip	query		integer (int64)	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
top	query		integer (int64)	The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

Responses

Name	Type	Description
200 OK	BillingSubscriptionListResult	The list of billing subscriptions.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

BillingSubscriptionsListByBillingAccount

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions?includeDeleted=False&includeTenantSubscriptions=False&api-version=2024-04-01

Java

/**
 * Samples for BillingSubscriptions ListByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingSubscriptionsListByBillingAccount.json
     */
    /**
     * Sample code: BillingSubscriptionsListByBillingAccount.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void
        billingSubscriptionsListByBillingAccount(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingSubscriptions().listByBillingAccount(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", false, false, null,
            null, null, null, null, null, null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python billing_subscriptions_list_by_billing_account.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.billing_subscriptions.list_by_billing_account(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json
func ExampleSubscriptionsClient_NewListByBillingAccountPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSubscriptionsClient().NewListByBillingAccountPager("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", &armbilling.SubscriptionsClientListByBillingAccountOptions{IncludeDeleted: to.Ptr(false),
		IncludeTenantSubscriptions: to.Ptr(false),
		IncludeFailed:              nil,
		Expand:                     nil,
		Filter:                     nil,
		OrderBy:                    nil,
		Top:                        nil,
		Skip:                       nil,
		Count:                      nil,
		Search:                     nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SubscriptionListResult = armbilling.SubscriptionListResult{
		// 	Value: []*armbilling.Subscription{
		// 		{
		// 			Name: to.Ptr("90000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000"),
		// 			SystemData: &armbilling.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-04T22:39:34.260Z"); return t}()),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-05T22:39:34.260Z"); return t}()),
		// 			},
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				AutoRenew: to.Ptr(armbilling.AutoRenewOn),
		// 				BillingProfileDisplayName: to.Ptr("Billing Profile Display Name"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 				BillingProfileName: to.Ptr("xxxx-xxxx-xxx-xxx"),
		// 				DisplayName: to.Ptr("My subscription"),
		// 				InvoiceSectionDisplayName: to.Ptr("Invoice Section Display Name"),
		// 				InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy"),
		// 				InvoiceSectionName: to.Ptr("yyyy-yyyy-yyy-yyy"),
		// 				ProductCategory: to.Ptr("SeatBased"),
		// 				ProductType: to.Ptr("Seat-Based Product Type"),
		// 				ProductTypeID: to.Ptr("XYZ56789"),
		// 				PurchaseDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-04T22:39:34.260Z"); return t}()),
		// 				Quantity: to.Ptr[int64](1),
		// 				ResourceURI: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000"),
		// 				SKUDescription: to.Ptr("SKU Description"),
		// 				SKUID: to.Ptr("0001"),
		// 				Status: to.Ptr(armbilling.BillingSubscriptionStatusActive),
		// 				SystemOverrides: &armbilling.SystemOverrides{
		// 					CancellationAllowedEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-01T22:39:34.260Z"); return t}()),
		// 				},
		// 				TermDuration: to.Ptr("P1M"),
		// 				TermEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-05T22:39:34.260Z"); return t}()),
		// 				TermStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-05T22:39:34.260Z"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("90000000-0000-0000-0000-000000000001"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001"),
		// 			SystemData: &armbilling.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-06T22:39:34.260Z"); return t}()),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-07T22:39:34.260Z"); return t}()),
		// 			},
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				AutoRenew: to.Ptr(armbilling.AutoRenewOn),
		// 				BillingProfileDisplayName: to.Ptr("Billing Profile Display Name"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 				BillingProfileName: to.Ptr("xxxx-xxxx-xxx-xxx"),
		// 				DisplayName: to.Ptr("Test subscription"),
		// 				InvoiceSectionDisplayName: to.Ptr("Invoice Section Display Name"),
		// 				InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy"),
		// 				InvoiceSectionName: to.Ptr("yyyy-yyyy-yyy-yyy"),
		// 				ProductCategory: to.Ptr("Software"),
		// 				ProductType: to.Ptr("Software Product Type"),
		// 				ProductTypeID: to.Ptr("EFG456"),
		// 				PurchaseDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-06T22:39:34.260Z"); return t}()),
		// 				Quantity: to.Ptr[int64](1),
		// 				ResourceURI: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001"),
		// 				SKUDescription: to.Ptr("SKU Description"),
		// 				SKUID: to.Ptr("0001"),
		// 				Status: to.Ptr(armbilling.BillingSubscriptionStatusActive),
		// 				SystemOverrides: &armbilling.SystemOverrides{
		// 					CancellationAllowedEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-01T22:39:34.260Z"); return t}()),
		// 				},
		// 				TermDuration: to.Ptr("P1M"),
		// 				TermEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-07T22:39:34.260Z"); return t}()),
		// 				TermStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-07T22:39:34.260Z"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("90000000-0000-0000-0000-000000000002"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/billingSubscriptions"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000002"),
		// 			SystemData: &armbilling.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-05T22:39:34.260Z"); return t}()),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-25T22:39:34.260Z"); return t}()),
		// 			},
		// 			Properties: &armbilling.SubscriptionProperties{
		// 				AutoRenew: to.Ptr(armbilling.AutoRenewOn),
		// 				BillingProfileDisplayName: to.Ptr("Billing Profile Display Name"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 				BillingProfileName: to.Ptr("xxxx-xxxx-xxx-xxx"),
		// 				DisplayName: to.Ptr("Dev subscription"),
		// 				InvoiceSectionDisplayName: to.Ptr("Invoice Section Display Name"),
		// 				InvoiceSectionID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy"),
		// 				InvoiceSectionName: to.Ptr("yyyy-yyyy-yyy-yyy"),
		// 				ProductCategory: to.Ptr("ReservationOrder"),
		// 				ProductType: to.Ptr("Reservation Product Type"),
		// 				ProductTypeID: to.Ptr("JKL789"),
		// 				PurchaseDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-05T22:39:34.260Z"); return t}()),
		// 				Quantity: to.Ptr[int64](1),
		// 				ResourceURI: to.Ptr("/providers/Microsoft.Capacity/reservationOrders/90000000-0000-0000-0000-000000000002"),
		// 				SKUDescription: to.Ptr("SKU Description"),
		// 				SKUID: to.Ptr("0001"),
		// 				Status: to.Ptr(armbilling.BillingSubscriptionStatusSuspended),
		// 				SuspensionReasonDetails: []*armbilling.SubscriptionStatusDetails{
		// 					{
		// 						EffectiveDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-15T22:39:34.260Z"); return t}()),
		// 						Reason: to.Ptr(armbilling.SubscriptionStatusReasonCancelled),
		// 				}},
		// 				SuspensionReasons: []*string{
		// 					to.Ptr("Cancelled")},
		// 					SystemOverrides: &armbilling.SystemOverrides{
		// 						CancellationAllowedEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-01T22:39:34.260Z"); return t}()),
		// 					},
		// 					TermDuration: to.Ptr("P1M"),
		// 					TermEndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-05T22:39:34.260Z"); return t}()),
		// 					TermStartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-05T22:39:34.260Z"); return t}()),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the subscriptions for a billing account.
 *
 * @summary Lists the subscriptions for a billing account.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json
 */
async function billingSubscriptionsListByBillingAccount() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const includeDeleted = false;
  const includeTenantSubscriptions = false;
  const options = {
    includeDeleted,
    includeTenantSubscriptions,
  };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.billingSubscriptions.listByBillingAccount(
    billingAccountName,
    options,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingAccount.json
// this example is just showing the usage of "BillingSubscriptions_ListByBillingAccount" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingAccountResource created on azure
// for more information of creating BillingAccountResource, please refer to the document of BillingAccountResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
ResourceIdentifier billingAccountResourceId = BillingAccountResource.CreateResourceIdentifier(billingAccountName);
BillingAccountResource billingAccount = client.GetBillingAccountResource(billingAccountResourceId);

// get the collection of this BillingSubscriptionResource
BillingSubscriptionCollection collection = billingAccount.GetBillingSubscriptions();

// invoke the operation and iterate over the result
BillingSubscriptionCollectionGetAllOptions options = new BillingSubscriptionCollectionGetAllOptions { IncludeDeleted = false, IncludeTenantSubscriptions = false };
await foreach (BillingSubscriptionResource item in collection.GetAllAsync(options))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BillingSubscriptionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000",
      "name": "90000000-0000-0000-0000-000000000000",
      "properties": {
        "autoRenew": "On",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "billingProfileDisplayName": "Billing Profile Display Name",
        "billingProfileName": "xxxx-xxxx-xxx-xxx",
        "displayName": "My subscription",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy",
        "invoiceSectionDisplayName": "Invoice Section Display Name",
        "invoiceSectionName": "yyyy-yyyy-yyy-yyy",
        "productCategory": "SeatBased",
        "productType": "Seat-Based Product Type",
        "productTypeId": "XYZ56789",
        "purchaseDate": "2023-01-04T22:39:34.2606750Z",
        "quantity": 1,
        "skuId": "0001",
        "skuDescription": "SKU Description",
        "systemOverrides": {
          "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z"
        },
        "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000000",
        "termDuration": "P1M",
        "termStartDate": "2023-01-05T22:39:34.2606750Z",
        "termEndDate": "2023-02-05T22:39:34.2606750Z",
        "status": "Active"
      },
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001",
      "name": "90000000-0000-0000-0000-000000000001",
      "properties": {
        "autoRenew": "On",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "billingProfileDisplayName": "Billing Profile Display Name",
        "billingProfileName": "xxxx-xxxx-xxx-xxx",
        "displayName": "Test subscription",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy",
        "invoiceSectionDisplayName": "Invoice Section Display Name",
        "invoiceSectionName": "yyyy-yyyy-yyy-yyy",
        "productCategory": "Software",
        "productType": "Software Product Type",
        "productTypeId": "EFG456",
        "purchaseDate": "2023-01-06T22:39:34.2606750Z",
        "quantity": 1,
        "skuId": "0001",
        "skuDescription": "SKU Description",
        "systemOverrides": {
          "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z"
        },
        "resourceUri": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000001",
        "termDuration": "P1M",
        "termStartDate": "2023-01-07T22:39:34.2606750Z",
        "termEndDate": "2023-02-07T22:39:34.2606750Z",
        "status": "Active"
      },
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "systemData": {
        "createdAt": "2023-01-06T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-07T22:39:34.2606750Z"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingSubscriptions/90000000-0000-0000-0000-000000000002",
      "name": "90000000-0000-0000-0000-000000000002",
      "properties": {
        "autoRenew": "On",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "billingProfileDisplayName": "Billing Profile Display Name",
        "billingProfileName": "xxxx-xxxx-xxx-xxx",
        "displayName": "Dev subscription",
        "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy",
        "invoiceSectionDisplayName": "Invoice Section Display Name",
        "invoiceSectionName": "yyyy-yyyy-yyy-yyy",
        "productCategory": "ReservationOrder",
        "productType": "Reservation Product Type",
        "productTypeId": "JKL789",
        "purchaseDate": "2023-01-05T22:39:34.2606750Z",
        "quantity": 1,
        "skuId": "0001",
        "skuDescription": "SKU Description",
        "systemOverrides": {
          "cancellationAllowedEndDate": "2023-02-01T22:39:34.2606750Z"
        },
        "resourceUri": "/providers/Microsoft.Capacity/reservationOrders/90000000-0000-0000-0000-000000000002",
        "termDuration": "P1M",
        "termStartDate": "2023-01-05T22:39:34.2606750Z",
        "termEndDate": "2023-02-05T22:39:34.2606750Z",
        "status": "Suspended",
        "suspensionReasons": [
          "Cancelled"
        ],
        "suspensionReasonDetails": [
          {
            "effectiveDate": "2023-01-15T22:39:34.2606750Z",
            "reason": "Cancelled"
          }
        ]
      },
      "type": "Microsoft.Billing/billingAccounts/billingSubscriptions",
      "systemData": {
        "createdAt": "2023-01-05T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-25T22:39:34.2606750Z"
      }
    }
  ]
}

Definitions

Name	Description
Amount	The amount.
AutoRenew	Indicates whether auto renewal is turned on or off for a product.
Beneficiary	Details of the beneficiary.
BillingSubscription	The billing properties of a subscription.
BillingSubscriptionListResult	A container for a list of resources
BillingSubscriptionOperationStatus	The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.
BillingSubscriptionStatus	The status of the subscription. This field is not available for Enterprise Agreement billing accounts
BillingSubscriptionStatusDetails	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
Cancellation	The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
NextBillingCycleDetails	Billing cycle details of the product.
ProvisioningState	The provisioning state of the resource during a long-running operation.
RenewalTermDetails	Details for the next renewal term of a subscription.
Reseller	Details of the reseller.
SubscriptionEnrollmentAccountStatus	The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.
SubscriptionStatusReason	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
systemData	Metadata pertaining to creation and last modification of the resource.
SystemOverrides	System imposed policies that regulate behavior of the subscription.

Amount

Object

The amount.

Name	Type	Description
currency	string	The currency for the amount value.
value	number	The amount value. For example, if the currency is USD, then a value of 600 would be $600.00.

AutoRenew

Enumeration

Indicates whether auto renewal is turned on or off for a product.

Value	Description
Off
On

Beneficiary

Object

Details of the beneficiary.

Name	Type	Description
objectId	string	The ID that uniquely identifies a user in a tenant.
tenantId	string	The ID that uniquely identifies a tenant.

BillingSubscription

Object

The billing properties of a subscription.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.autoRenew	AutoRenew	Indicates whether auto renewal is turned on or off for a product.
properties.beneficiary	Beneficiary	The beneficiary of the billing subscription.
properties.beneficiaryTenantId	string	The provisioning tenant of the subscription.
properties.billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y
properties.billingPolicies	object	Dictionary of billing policies associated with the subscription.
properties.billingProfileDisplayName	string	The name of the billing profile.
properties.billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
properties.billingProfileName	string	The ID that uniquely identifies a billing profile.
properties.consumptionCostCenter	string	The cost center applied to the subscription. This field is only available for consumption subscriptions of Microsoft Customer Agreement or Enterprise Agreement Type billing accounts.
properties.customerDisplayName	string	The name of the customer.
properties.customerId	string	The fully qualified ID that uniquely identifies a customer.
properties.customerName	string	The ID that uniquely identifies a customer.
properties.displayName	string	The name of the billing subscription.
properties.enrollmentAccountDisplayName	string	The enrollment Account name associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
properties.enrollmentAccountId	string	The enrollment Account ID associated with the subscription. This field is available only for the Enterprise Agreement Type billing accounts.
properties.enrollmentAccountSubscriptionDetails.enrollmentAccountStartDate	string (date-time)	The enrollment Account and the subscription association start date. This field is available only for the Enterprise Agreement Type.
properties.enrollmentAccountSubscriptionDetails.subscriptionEnrollmentAccountStatus	SubscriptionEnrollmentAccountStatus	The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.
properties.invoiceSectionDisplayName	string	The name of the invoice section.
properties.invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
properties.invoiceSectionName	string	The ID that uniquely identifies an invoice section.
properties.lastMonthCharges	Amount	The last month's charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
properties.monthToDateCharges	Amount	The current month to date charges. This field is only available for usage based subscriptions of Microsoft Customer Agreement billing accounts.
properties.nextBillingCycleDetails	NextBillingCycleDetails	Next billing cycle details of the subscription.
properties.offerId	string	The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement.
properties.operationStatus	BillingSubscriptionOperationStatus	The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.
properties.productCategory	string	The category of the product for which the subscription is purchased. Possible values include: AzureSupport, Hardware, ReservationOrder, SaaS, SavingsPlanOrder, Software, UsageBased, Other.
properties.productType	string	Type of the product for which the subscription is purchased.
properties.productTypeId	string	Id of the product for which the subscription is purchased.
properties.provisioningState	ProvisioningState	The provisioning state of the resource during a long-running operation.
properties.provisioningTenantId	string	The tenant in which the subscription is provisioned.
properties.purchaseDate	string (date-time)	Purchase date of the product in UTC time.
properties.quantity	integer (int64)	The quantity of licenses or fulfillment units for the subscription.
properties.renewalTermDetails	RenewalTermDetails	Details for the next renewal term of a subscription.
properties.reseller	Reseller	Reseller for this subscription. The fields is not available for Microsoft Partner Agreement billing accounts.
properties.resourceUri	string	Unique identifier of the linked resource.
properties.skuDescription	string	The SKU description of the product for which the subscription is purchased. This field is is only available for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.
properties.skuId	string	The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.
properties.status	BillingSubscriptionStatus	The status of the subscription. This field is not available for Enterprise Agreement billing accounts
properties.subscriptionId	string	The ID of the subscription.
properties.suspensionReasonDetails	BillingSubscriptionStatusDetails[]	The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.
properties.suspensionReasons	string[]	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.
properties.systemOverrides	SystemOverrides	System imposed policies that regulate behavior of the subscription.
properties.termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y
properties.termEndDate	string (date-time)	End date of the term in UTC time.
properties.termStartDate	string (date-time)	Start date of the term in UTC time.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BillingSubscriptionListResult

Object

A container for a list of resources

Name	Type	Description
nextLink	string	The link (url) to the next page of results.
totalCount	number (int32)	Total number of records.
value	BillingSubscription[]	The list of resources.

BillingSubscriptionOperationStatus

Enumeration

The status of an operation on the subscription. When None, there is no ongoing operation. When LockedForUpdate, write operations will be blocked on the Billing Subscription. Other is the default value and you may need to refer to the latest API version for more details.

Value	Description
Other
None
LockedForUpdate

BillingSubscriptionStatus

Enumeration

The status of the subscription. This field is not available for Enterprise Agreement billing accounts

Value	Description
Other
Unknown
Active
Disabled
Deleted
Warned
Expiring
Expired
AutoRenew
Cancelled
Suspended
Failed

BillingSubscriptionStatusDetails

Object

The suspension details for a subscription. This field is not available for Enterprise Agreement billing accounts.

Name	Type	Description
effectiveDate	string (date-time)	The suspension effective date for a subscription. This field is not available for Enterprise Agreement billing accounts.
reason	SubscriptionStatusReason	The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.

Cancellation

Enumeration

The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.

Value	Description
NotAllowed
Allowed

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

NextBillingCycleDetails

Object

Billing cycle details of the product.

Name	Type	Description
billingFrequency	string	Billing frequency of the product under the subscription.

ProvisioningState

Enumeration

The provisioning state of the resource during a long-running operation.

Value	Description
Succeeded
Canceled
Failed
New
Pending
Provisioning

RenewalTermDetails

Object

Details for the next renewal term of a subscription.

Name	Type	Description
billingFrequency	string	The billing frequency in ISO8601 format of product in the subscription. Example: P1M, P3M, P1Y
productId	string	Id of the product for which the subscription is purchased.
productTypeId	string	Type Id of the product for which the subscription is purchased.
quantity	integer (int64)	The quantity of licenses or fulfillment units for the subscription.
skuId	string	The SKU ID of the product for which the subscription is purchased. This field is is only available for Microsoft Customer Agreement billing accounts.
termDuration	string	The duration in ISO8601 format for which you can use the subscription. Example: P1M, P3M, P1Y
termEndDate	string (date-time)	End date of the term in UTC time.

Reseller

Object

Details of the reseller.

Name	Type	Description
description	string	The name of the reseller.
resellerId	string	The MPN ID of the reseller.

SubscriptionEnrollmentAccountStatus

Enumeration

The current enrollment account status of the subscription. This field is available only for the Enterprise Agreement Type.

Value	Description
Active
Cancelled
Expired
Deleted
TransferredOut
Transferring
Inactive

SubscriptionStatusReason

Enumeration

The suspension reason for a subscription. This field is not available for Enterprise Agreement billing accounts.

Value	Description
None
Cancelled
PastDue
SuspiciousActivity
Other
Transferred
PolicyViolation
SpendingLimitReached
Expired

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

SystemOverrides

Object

System imposed policies that regulate behavior of the subscription.

Name	Type	Description
cancellation	Cancellation	The policy override for the subscription indicates whether the self-serve cancellation or seat reduction is allowed.
cancellationAllowedEndDate	string (date-time)	The end date in UTC time by when the self-serve cancellation ends.