Billing Accounts - List

Service:

Billing

API Version:

2024-04-01

Lists the billing accounts that a user has access to.

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

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01&includeAll={includeAll}&includeAllWithoutBillingProfiles={includeAllWithoutBillingProfiles}&includeDeleted={includeDeleted}&includePendingAgreement={includePendingAgreement}&includeResellee={includeResellee}&legalOwnerTID={legalOwnerTID}&legalOwnerOID={legalOwnerOID}&filter={filter}&expand={expand}&top={top}&skip={skip}&search={search}

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string minLength: 1	The API version to use for this operation.
expand	query		string	Expand is allowed for SoldTo and EnrollmentDetails/PONumber.
filter	query		string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
includeAll	query		boolean	When true, results will include Billing Accounts that the user does not have a direct role assignment on if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.
includeAllWithoutBillingProfiles	query		boolean	When true, results will include Billing Accounts that are not fully created if the user has one of the following AAD roles: Global Administrator, Global Reader, Billing Administrator.
includeDeleted	query		boolean	When true, results will include any billing accounts in a deleted state.
includePendingAgreement	query		boolean	Includes billing accounts with agreement pending signature that the user has access to.
includeResellee	query		boolean	Includes the customer's billing account of Microsoft Partner Agreement that the user has access to.
legalOwnerOID	query		string	Must be combined with legalOwnerTID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.
legalOwnerTID	query		string	Must be combined with legalOwnerOID, results will only include Billing Accounts for whom is legally responsible for the Billing Accounts. Optional.
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	BillingAccountListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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

BillingAccountForLegacyAccountDetails

BillingAccountsList

BillingAccountsListWithExpandForPONumber

BillingAccountForLegacyAccountDetails

Sample request

HTTP

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

Sample response

Status code:

200

{
  "value": [
    {
      "name": "20000000-0000-0000-0000-000000000001",
      "type": "Microsoft.Billing/billingAccounts",
      "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001",
      "properties": {
        "accountStatus": "Active",
        "accountType": "Individual",
        "agreementType": "MicrosoftOnlineServicesProgram",
        "displayName": "Individual Account 2",
        "hasReadAccess": true,
        "notificationEmailAddress": "individual@domain.com"
      }
    }
  ]
}

BillingAccountsList

Sample request

HTTP

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

Sample response

Status code:

200

{
  "value": [
    {
      "name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "type": "Microsoft.Billing/billingAccounts",
      "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountSubType": "Enterprise",
        "accountType": "Business",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Premier Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "name": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "type": "Microsoft.Billing/billingAccounts",
      "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountSubType": "Professional",
        "accountType": "Business",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Standard Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "name": "30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "type": "Microsoft.Billing/billingAccounts",
      "id": "/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountSubType": "Individual",
        "accountType": "Individual",
        "agreementType": "MicrosoftCustomerAgreement",
        "displayName": "Individual Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    },
    {
      "name": "40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "type": "Microsoft.Billing/billingAccounts",
      "id": "/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
      "properties": {
        "accountStatus": "Active",
        "accountSubType": "Enterprise",
        "accountType": "Business",
        "agreementType": "MicrosoftPartnerAgreement",
        "displayName": "Premier Business Account",
        "hasReadAccess": true,
        "primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
      },
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    }
  ]
}

BillingAccountsListWithExpandForPONumber

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01&expand=soldTo,enrollmentDetails/poNumber

Sample response

Status code:

200

{
  "value": [
    {
      "name": "6564892",
      "type": "Microsoft.Billing/billingAccounts",
      "id": "/providers/Microsoft.Billing/billingAccounts/6564892",
      "properties": {
        "accountStatus": "Active",
        "accountSubType": "None",
        "accountType": "Enterprise",
        "agreementType": "EnterpriseAgreement",
        "displayName": "Enterprise Account",
        "enrollmentDetails": {
          "billingCycle": "Monthly",
          "channel": "EaDirect",
          "cloud": "Azure Commercial",
          "countryCode": "US",
          "currency": "USD",
          "endDate": "2019-05-31T17:32:28Z",
          "extendedTermOption": "Opted-Out",
          "poNumber": "poNumber123",
          "startDate": "2018-05-01T17:32:28Z",
          "supportCoverage": "1/26/2021 - 6/30/2021",
          "supportLevel": "Standard",
          "language": "en"
        },
        "hasReadAccess": true,
        "soldTo": {
          "addressLine1": "Test Address",
          "city": "City",
          "companyName": "Enterprise Company",
          "country": "US",
          "postalCode": "00000-1111",
          "region": "WA"
        }
      },
      "systemData": {
        "createdAt": "2023-01-04T22:39:34.2606750Z",
        "lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
      }
    }
  ]
}

Definitions

Name	Description
AccountStatus	The current status of the billing account.
AccountSubType	The tier of the account.
AccountType	The type of customer.
AgreementType	The type of agreement.
BillingAccount	A billing account.
BillingAccountListResult	Paged collection of BillingAccount items
BillingAccountProperties	A billing account.
BillingAccountPropertiesEnrollmentDetails	The properties of an enrollment.
BillingAccountPropertiesRegistrationNumber	Describes the registration number of the organization linked with the billing account.
BillingAccountPropertiesSoldTo	The address of the individual or organization that is responsible for the billing account.
BillingAccountStatusReasonCode	Reason for the specified billing account status.
BillingRelationshipType	Identifies the billing relationships represented by a billing account or billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.
createdByType	The type of identity that created the resource.
EnrollmentDetailsIndirectRelationshipInfo	The properties of an enrollment which are applicable only for indirect enrollments.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedTermOption	The billing account extension opted by the company.
MarkupStatus	Markup status of enrollment, applicable only for indirect enrollments.
ProvisioningState	The provisioning state of the resource during a long-running operation.
SupportLevel	The support level offer associated with an enrollment.
systemData	Metadata pertaining to creation and last modification of the resource.
TaxIdentifier	A tax identifier for the billing account.
TaxIdentifierStatus	The status of the tax identifier.
TaxIdentifierType	The type of the tax identifier.

AccountStatus

Enumeration

The current status of the billing account.

Value	Description
Other	Other
Active	Active
UnderReview	UnderReview
Disabled	Disabled
Deleted	Deleted
Extended	Extended
Pending	Pending
New	New
Expired	Expired
Terminated	Terminated
Transferred	Transferred

AccountSubType

Enumeration

The tier of the account.

Value	Description
Other	Other
None	None
Individual	Individual
Professional	Professional
Enterprise	Enterprise

AccountType

Enumeration

The type of customer.

Value	Description
Other	Other
Enterprise	Enterprise
Individual	Individual
Partner	Partner
Reseller	Reseller
ClassicPartner	ClassicPartner
Internal	Internal
Tenant	Tenant
Business	Business

AgreementType

Enumeration

The type of agreement.

Value	Description
Other	Other
MicrosoftCustomerAgreement	MicrosoftCustomerAgreement
EnterpriseAgreement	EnterpriseAgreement
MicrosoftOnlineServicesProgram	MicrosoftOnlineServicesProgram
MicrosoftPartnerAgreement	MicrosoftPartnerAgreement

BillingAccount

Object

A billing account.

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	BillingAccountProperties	A billing account.
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"

BillingAccountListResult

Object

Paged collection of BillingAccount items

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	BillingAccount[]	The BillingAccount items on this page

BillingAccountProperties

Object

A billing account.

Name	Type	Description
accountStatus	AccountStatus	The current status of the billing account.
accountStatusReasonCode	BillingAccountStatusReasonCode	Reason for the specified billing account status.
accountSubType	AccountSubType	The tier of the account.
accountType	AccountType	The type of customer.
agreementType	AgreementType	The type of agreement.
billingRelationshipTypes	BillingRelationshipType[]	Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party.
displayName	string	The billing account name.
enrollmentDetails	BillingAccountPropertiesEnrollmentDetails	The properties of an enrollment.
hasNoBillingProfiles	boolean	Indicates whether or not the billing account has any billing profiles.
hasReadAccess	boolean	Indicates whether user has read access to the billing account.
notificationEmailAddress	string	Notification email address for legacy account. Available for agreement type Microsoft Online Services Program.
primaryBillingTenantId	string	The tenant that was used to set up the billing account. By default, only users from this tenant can get role assignments on the billing account and all purchases are provisioned in this tenant.
provisioningState	ProvisioningState	The provisioning state of the resource during a long-running operation.
qualifications	string[]	Qualifications for pricing on a billing account. Values may be Commercial, Education, Charity or Government.
registrationNumber	BillingAccountPropertiesRegistrationNumber	Describes the registration number of the organization linked with the billing account.
soldTo	BillingAccountPropertiesSoldTo	The address of the individual or organization that is responsible for the billing account.
taxIds	TaxIdentifier[]	A list of tax identifiers for the billing account.

BillingAccountPropertiesEnrollmentDetails

Object

The properties of an enrollment.

Name	Type	Description
billingCycle	string	The billing cycle for the enrollment.
channel	string	The channel type of the enrollment.
cloud	string	The cloud of the enrollment.
countryCode	string	The country code of the enrollment.
currency	string	The billing currency for the enrollment.
endDate	string (date-time)	The end date of the enrollment.
extendedTermOption	ExtendedTermOption	The billing account extension opted by the company.
indirectRelationshipInfo	EnrollmentDetailsIndirectRelationshipInfo	The properties of an enrollment which are applicable only for indirect enrollments.
invoiceRecipient	string	The contact who receives invoices of the enrollment.
language	string	The language for the enrollment.
markupStatus	MarkupStatus	Markup status of enrollment, applicable only for indirect enrollments.
poNumber	string	The purchase order number of the enrollment.
startDate	string (date-time)	The start date of the enrollment.
supportCoverage	string	The support coverage period for the enrollment.
supportLevel	SupportLevel	The support level offer associated with an enrollment.

BillingAccountPropertiesRegistrationNumber

Object

Describes the registration number of the organization linked with the billing account.

Name	Type	Description
id	string	The unique identification number of the organization linked with the billing account.
required	boolean	Identifies if the registration number is required for the billing account.
type	string[]	The types of registration number allowed based on the country of the billing account.

BillingAccountPropertiesSoldTo

Object

The address of the individual or organization that is responsible for the billing account.

Name	Type	Description
addressLine1	string minLength: 1	Address line 1.
addressLine2	string	Address line 2.
addressLine3	string	Address line 3.
city	string	Address city.
companyName	string	Company name. Optional for MCA Individual (Pay-as-you-go).
country	string minLength: 1	Country code uses ISO 3166-1 Alpha-2 format.
district	string	Address district.
email	string	Email address.
firstName	string	First name. Optional for MCA Enterprise.
isValidAddress	boolean	Indicates if the address is incomplete.
lastName	string	Last name. Optional for MCA Enterprise.
middleName	string	Middle name.
phoneNumber	string	Phone number.
postalCode	string	Postal code.
region	string	Address region.

BillingAccountStatusReasonCode

Enumeration

Reason for the specified billing account status.

Value	Description
Other	Other
UnusualActivity	UnusualActivity
ManuallyTerminated	ManuallyTerminated
Expired	Expired
Transferred	Transferred
TerminateProcessing	TerminateProcessing

BillingRelationshipType

Enumeration

Identifies the billing relationships represented by a billing account or billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party.

Value	Description
Other	Other
Direct	Direct
IndirectCustomer	IndirectCustomer
IndirectPartner	IndirectPartner
CSPPartner	CSPPartner
CSPCustomer	CSPCustomer

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

EnrollmentDetailsIndirectRelationshipInfo

Object

The properties of an enrollment which are applicable only for indirect enrollments.

Name	Type	Description
billingAccountName	string	The billing account name of the partner or the customer for an indirect motion.
billingProfileName	string	The billing profile name of the partner or the customer for an indirect motion.
displayName	string	The display name of the partner or customer for an indirect motion.

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.

ExtendedTermOption

Enumeration

The billing account extension opted by the company.

Value	Description
Other	Other
Opted-In	Opted-In
Opted-Out	Opted-Out

MarkupStatus

Enumeration

Markup status of enrollment, applicable only for indirect enrollments.

Value	Description
Other	Other
Disabled	Disabled
Preview	Preview
Published	Published
Locked	Locked

ProvisioningState

Enumeration

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

Value	Description
Succeeded	Succeeded
Canceled	Canceled
Failed	Failed
New	New
Pending	Pending
Provisioning	Provisioning
PendingBilling	PendingBilling
ConfirmedBilling	ConfirmedBilling
Creating	Creating
Created	Created
Expired	Expired

SupportLevel

Enumeration

The support level offer associated with an enrollment.

Value	Description
Other	Other
Standard	Standard
Pro-Direct	Pro-Direct
Developer	Developer

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.

TaxIdentifier

Object

A tax identifier for the billing account.

Name	Type	Description
country	string	The country of the tax identifier.
id	string	The id of the tax identifier.
scope	string	The scope of the tax identifier.
status	TaxIdentifierStatus	The status of the tax identifier.
type	TaxIdentifierType	The type of the tax identifier.

TaxIdentifierStatus

Enumeration

The status of the tax identifier.

Value	Description
Other	Other
Valid	Valid
Invalid	Invalid

TaxIdentifierType

Enumeration

The type of the tax identifier.

Value	Description
Other	Other
BrazilCcmId	BrazilCcmId
BrazilCnpjId	BrazilCnpjId
BrazilCpfId	BrazilCpfId
CanadianFederalExempt	CanadianFederalExempt
CanadianProvinceExempt	CanadianProvinceExempt
ExternalTaxation	ExternalTaxation
IndiaFederalTanId	IndiaFederalTanId
IndiaFederalServiceTaxId	IndiaFederalServiceTaxId
IndiaPanId	IndiaPanId
IndiaStateCstId	IndiaStateCstId
IndiaStateGstINId	IndiaStateGstINId
IndiaStateVatId	IndiaStateVatId
IntlExempt	IntlExempt
USExempt	USExempt
VatId	VatId
LoveCode	LoveCode
MobileBarCode	MobileBarCode
NationalIdentificationNumber	NationalIdentificationNumber
PublicSectorId	PublicSectorId