Share via


Billing Subscriptions - List By Billing Account

Lists the subscriptions for a billing account.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions?api-version=2024-04-01
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

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

Sample response

{
  "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

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

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

Value Description
Off
On

Beneficiary

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

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

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

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

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

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

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

Value Description
NotAllowed
Allowed

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

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

Error response

Name Type Description
error

ErrorDetail

The error object.

NextBillingCycleDetails

Billing cycle details of the product.

Name Type Description
billingFrequency

string

Billing frequency of the product under the subscription.

ProvisioningState

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

Value Description
Succeeded
Canceled
Failed
New
Pending
Provisioning

RenewalTermDetails

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

Details of the reseller.

Name Type Description
description

string

The name of the reseller.

resellerId

string

The MPN ID of the reseller.

SubscriptionEnrollmentAccountStatus

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

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

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

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.