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?includeAll={includeAll}&includeAllWithoutBillingProfiles={includeAllWithoutBillingProfiles}&includeDeleted={includeDeleted}&includePendingAgreement={includePendingAgreement}&includeResellee={includeResellee}&legalOwnerTID={legalOwnerTID}&legalOwnerOID={legalOwnerOID}&api-version=2024-04-01&filter={filter}&expand={expand}&top={top}&skip={skip}&search={search}
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
api-version
|
query |
True
|
string
|
The version of the API to be used with the client request. The current version is 2024-04-01.
|
|
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
Examples
BillingAccountForLegacyAccountDetails
Sample request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01
/**
* Samples for BillingAccounts List.
*/
public final class Main {
/*
* x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
* billingAccountForLegacyAccountDetails.json
*/
/**
* Sample code: BillingAccountForLegacyAccountDetails.
*
* @param manager Entry point to BillingManager.
*/
public static void billingAccountForLegacyAccountDetails(com.azure.resourcemanager.billing.BillingManager manager) {
manager.billingAccounts().list(null, null, null, null, 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
from azure.identity import DefaultAzureCredential
from azure.mgmt.billing import BillingManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-billing
# USAGE
python billing_account_for_legacy_account_details.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_accounts.list()
for item in response:
print(item)
# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.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
package armbilling_test
import (
"context"
"log"
"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/billingAccountForLegacyAccountDetails.json
func ExampleAccountsClient_NewListPager_billingAccountForLegacyAccountDetails() {
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.NewAccountsClient().NewListPager(&armbilling.AccountsClientListOptions{IncludeAll: nil,
IncludeAllWithoutBillingProfiles: nil,
IncludeDeleted: nil,
IncludePendingAgreement: nil,
IncludeResellee: nil,
LegalOwnerTID: nil,
LegalOwnerOID: nil,
Filter: nil,
Expand: nil,
Top: nil,
Skip: 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.AccountListResult = armbilling.AccountListResult{
// Value: []*armbilling.Account{
// {
// Name: to.Ptr("20000000-0000-0000-0000-000000000001"),
// Type: to.Ptr("Microsoft.Billing/billingAccounts"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001"),
// Properties: &armbilling.AccountProperties{
// AccountStatus: to.Ptr(armbilling.AccountStatusActive),
// AccountType: to.Ptr(armbilling.AccountTypeIndividual),
// AgreementType: to.Ptr(armbilling.AgreementTypeMicrosoftOnlineServicesProgram),
// DisplayName: to.Ptr("Individual Account 2"),
// HasReadAccess: to.Ptr(true),
// NotificationEmailAddress: to.Ptr("individual@domain.com"),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists the billing accounts that a user has access to.
*
* @summary Lists the billing accounts that a user has access to.
* x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountForLegacyAccountDetails.json
*/
async function billingAccountForLegacyAccountDetails() {
const credential = new DefaultAzureCredential();
const client = new BillingManagementClient(credential);
const resArray = new Array();
for await (let item of client.billingAccounts.list()) {
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
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/billingAccountForLegacyAccountDetails.json
// this example is just showing the usage of "BillingAccounts_List" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;
// get the collection of this BillingAccountResource
BillingAccountCollection collection = tenantResource.GetBillingAccounts();
// invoke the operation and iterate over the result
BillingAccountCollectionGetAllOptions options = new BillingAccountCollectionGetAllOptions() { };
await foreach (BillingAccountResource 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
BillingAccountData 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
{
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000001",
"name": "20000000-0000-0000-0000-000000000001",
"properties": {
"accountStatus": "Active",
"accountType": "Individual",
"agreementType": "MicrosoftOnlineServicesProgram",
"displayName": "Individual Account 2",
"hasReadAccess": true,
"notificationEmailAddress": "individual@domain.com"
},
"type": "Microsoft.Billing/billingAccounts"
}
]
}
BillingAccountsList
Sample request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01
/**
* Samples for BillingAccounts List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsList.json
*/
/**
* Sample code: BillingAccountsList.
*
* @param manager Entry point to BillingManager.
*/
public static void billingAccountsList(com.azure.resourcemanager.billing.BillingManager manager) {
manager.billingAccounts().list(null, null, null, null, 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
from azure.identity import DefaultAzureCredential
from azure.mgmt.billing import BillingManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-billing
# USAGE
python billing_accounts_list.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_accounts.list()
for item in response:
print(item)
# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsList.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
package armbilling_test
import (
"context"
"log"
"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/billingAccountsList.json
func ExampleAccountsClient_NewListPager_billingAccountsList() {
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.NewAccountsClient().NewListPager(&armbilling.AccountsClientListOptions{IncludeAll: nil,
IncludeAllWithoutBillingProfiles: nil,
IncludeDeleted: nil,
IncludePendingAgreement: nil,
IncludeResellee: nil,
LegalOwnerTID: nil,
LegalOwnerOID: nil,
Filter: nil,
Expand: nil,
Top: nil,
Skip: 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.AccountListResult = armbilling.AccountListResult{
// Value: []*armbilling.Account{
// {
// Name: to.Ptr("10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
// Type: to.Ptr("Microsoft.Billing/billingAccounts"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
// 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.AccountProperties{
// AccountStatus: to.Ptr(armbilling.AccountStatusActive),
// AccountSubType: to.Ptr(armbilling.AccountSubTypeEnterprise),
// AccountType: to.Ptr(armbilling.AccountTypeBusiness),
// AgreementType: to.Ptr(armbilling.AgreementTypeMicrosoftCustomerAgreement),
// DisplayName: to.Ptr("Premier Business Account"),
// HasReadAccess: to.Ptr(true),
// PrimaryBillingTenantID: to.Ptr("20000000-0000-0000-0000-000000000001"),
// },
// },
// {
// Name: to.Ptr("20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
// Type: to.Ptr("Microsoft.Billing/billingAccounts"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
// 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.AccountProperties{
// AccountStatus: to.Ptr(armbilling.AccountStatusActive),
// AccountSubType: to.Ptr(armbilling.AccountSubTypeProfessional),
// AccountType: to.Ptr(armbilling.AccountTypeBusiness),
// AgreementType: to.Ptr(armbilling.AgreementTypeMicrosoftCustomerAgreement),
// DisplayName: to.Ptr("Standard Business Account"),
// HasReadAccess: to.Ptr(true),
// PrimaryBillingTenantID: to.Ptr("20000000-0000-0000-0000-000000000001"),
// },
// },
// {
// Name: to.Ptr("30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
// Type: to.Ptr("Microsoft.Billing/billingAccounts"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
// 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.AccountProperties{
// AccountStatus: to.Ptr(armbilling.AccountStatusActive),
// AccountSubType: to.Ptr(armbilling.AccountSubTypeIndividual),
// AccountType: to.Ptr(armbilling.AccountTypeIndividual),
// AgreementType: to.Ptr(armbilling.AgreementTypeMicrosoftCustomerAgreement),
// DisplayName: to.Ptr("Individual Account"),
// HasReadAccess: to.Ptr(true),
// PrimaryBillingTenantID: to.Ptr("20000000-0000-0000-0000-000000000001"),
// },
// },
// {
// Name: to.Ptr("40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
// Type: to.Ptr("Microsoft.Billing/billingAccounts"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
// 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.AccountProperties{
// AccountStatus: to.Ptr(armbilling.AccountStatusActive),
// AccountSubType: to.Ptr(armbilling.AccountSubTypeEnterprise),
// AccountType: to.Ptr(armbilling.AccountTypeBusiness),
// AgreementType: to.Ptr(armbilling.AgreementTypeMicrosoftPartnerAgreement),
// DisplayName: to.Ptr("Premier Business Account"),
// HasReadAccess: to.Ptr(true),
// PrimaryBillingTenantID: to.Ptr("20000000-0000-0000-0000-000000000001"),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists the billing accounts that a user has access to.
*
* @summary Lists the billing accounts that a user has access to.
* x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsList.json
*/
async function billingAccountsList() {
const credential = new DefaultAzureCredential();
const client = new BillingManagementClient(credential);
const resArray = new Array();
for await (let item of client.billingAccounts.list()) {
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
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/billingAccountsList.json
// this example is just showing the usage of "BillingAccounts_List" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;
// get the collection of this BillingAccountResource
BillingAccountCollection collection = tenantResource.GetBillingAccounts();
// invoke the operation and iterate over the result
BillingAccountCollectionGetAllOptions options = new BillingAccountCollectionGetAllOptions() { };
await foreach (BillingAccountResource 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
BillingAccountData 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
{
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
"name": "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
"properties": {
"accountStatus": "Active",
"accountType": "Business",
"accountSubType": "Enterprise",
"agreementType": "MicrosoftCustomerAgreement",
"displayName": "Premier Business Account",
"hasReadAccess": true,
"primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
},
"type": "Microsoft.Billing/billingAccounts",
"systemData": {
"createdAt": "2023-01-04T22:39:34.2606750Z",
"lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
}
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
"name": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
"properties": {
"accountStatus": "Active",
"accountType": "Business",
"accountSubType": "Professional",
"agreementType": "MicrosoftCustomerAgreement",
"displayName": "Standard Business Account",
"hasReadAccess": true,
"primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
},
"type": "Microsoft.Billing/billingAccounts",
"systemData": {
"createdAt": "2023-01-04T22:39:34.2606750Z",
"lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
}
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
"name": "30000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
"properties": {
"accountStatus": "Active",
"accountType": "Individual",
"accountSubType": "Individual",
"agreementType": "MicrosoftCustomerAgreement",
"displayName": "Individual Account",
"hasReadAccess": true,
"primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
},
"type": "Microsoft.Billing/billingAccounts",
"systemData": {
"createdAt": "2023-01-04T22:39:34.2606750Z",
"lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
}
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
"name": "40000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
"properties": {
"accountStatus": "Active",
"accountType": "Business",
"accountSubType": "Enterprise",
"agreementType": "MicrosoftPartnerAgreement",
"displayName": "Premier Business Account",
"hasReadAccess": true,
"primaryBillingTenantId": "20000000-0000-0000-0000-000000000001"
},
"type": "Microsoft.Billing/billingAccounts",
"systemData": {
"createdAt": "2023-01-04T22:39:34.2606750Z",
"lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
}
}
]
}
BillingAccountsListWithExpandForPONumber
Sample request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts?api-version=2024-04-01&expand=soldTo,enrollmentDetails/poNumber
/**
* Samples for BillingAccounts List.
*/
public final class Main {
/*
* x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
* billingAccountsListWithExpandForPONumber.json
*/
/**
* Sample code: BillingAccountsListWithExpandForPONumber.
*
* @param manager Entry point to BillingManager.
*/
public static void
billingAccountsListWithExpandForPONumber(com.azure.resourcemanager.billing.BillingManager manager) {
manager.billingAccounts().list(null, null, null, null, null, null, null, null,
"soldTo,enrollmentDetails/poNumber", 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
from azure.identity import DefaultAzureCredential
from azure.mgmt.billing import BillingManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-billing
# USAGE
python billing_accounts_list_with_expand_for_po_number.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_accounts.list()
for item in response:
print(item)
# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.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
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/billingAccountsListWithExpandForPONumber.json
func ExampleAccountsClient_NewListPager_billingAccountsListWithExpandForPoNumber() {
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.NewAccountsClient().NewListPager(&armbilling.AccountsClientListOptions{IncludeAll: nil,
IncludeAllWithoutBillingProfiles: nil,
IncludeDeleted: nil,
IncludePendingAgreement: nil,
IncludeResellee: nil,
LegalOwnerTID: nil,
LegalOwnerOID: nil,
Filter: nil,
Expand: to.Ptr("soldTo,enrollmentDetails/poNumber"),
Top: nil,
Skip: 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.AccountListResult = armbilling.AccountListResult{
// Value: []*armbilling.Account{
// {
// Name: to.Ptr("6564892"),
// Type: to.Ptr("Microsoft.Billing/billingAccounts"),
// ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6564892"),
// 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.AccountProperties{
// AccountStatus: to.Ptr(armbilling.AccountStatusActive),
// AccountSubType: to.Ptr(armbilling.AccountSubTypeNone),
// AccountType: to.Ptr(armbilling.AccountTypeEnterprise),
// AgreementType: to.Ptr(armbilling.AgreementTypeEnterpriseAgreement),
// DisplayName: to.Ptr("Enterprise Account"),
// EnrollmentDetails: &armbilling.AccountPropertiesEnrollmentDetails{
// BillingCycle: to.Ptr("Monthly"),
// Channel: to.Ptr("EaDirect"),
// Cloud: to.Ptr("Azure Commercial"),
// CountryCode: to.Ptr("US"),
// Currency: to.Ptr("USD"),
// EndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-05-31T17:32:28.000Z"); return t}()),
// ExtendedTermOption: to.Ptr(armbilling.ExtendedTermOptionOptedOut),
// PoNumber: to.Ptr("poNumber123"),
// StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T17:32:28.000Z"); return t}()),
// SupportCoverage: to.Ptr("1/26/2021 - 6/30/2021"),
// SupportLevel: to.Ptr(armbilling.SupportLevelStandard),
// Language: to.Ptr("en"),
// },
// HasReadAccess: to.Ptr(true),
// SoldTo: &armbilling.AccountPropertiesSoldTo{
// AddressLine1: to.Ptr("Test Address"),
// City: to.Ptr("City"),
// CompanyName: to.Ptr("Enterprise Company"),
// Country: to.Ptr("US"),
// PostalCode: to.Ptr("00000-1111"),
// Region: to.Ptr("WA"),
// },
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists the billing accounts that a user has access to.
*
* @summary Lists the billing accounts that a user has access to.
* x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingAccountsListWithExpandForPONumber.json
*/
async function billingAccountsListWithExpandForPoNumber() {
const expand = "soldTo,enrollmentDetails/poNumber";
const options = { expand };
const credential = new DefaultAzureCredential();
const client = new BillingManagementClient(credential);
const resArray = new Array();
for await (let item of client.billingAccounts.list(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
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/billingAccountsListWithExpandForPONumber.json
// this example is just showing the usage of "BillingAccounts_List" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;
// get the collection of this BillingAccountResource
BillingAccountCollection collection = tenantResource.GetBillingAccounts();
// invoke the operation and iterate over the result
BillingAccountCollectionGetAllOptions options = new BillingAccountCollectionGetAllOptions() { Expand = "soldTo,enrollmentDetails/poNumber" };
await foreach (BillingAccountResource 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
BillingAccountData 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
{
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/6564892",
"name": "6564892",
"properties": {
"accountStatus": "Active",
"accountType": "Enterprise",
"accountSubType": "None",
"agreementType": "EnterpriseAgreement",
"displayName": "Enterprise Account",
"enrollmentDetails": {
"startDate": "2018-05-01T17:32:28Z",
"endDate": "2019-05-31T17:32:28Z",
"currency": "USD",
"channel": "EaDirect",
"language": "en",
"countryCode": "US",
"billingCycle": "Monthly",
"extendedTermOption": "Opted-Out",
"supportLevel": "Standard",
"supportCoverage": "1/26/2021 - 6/30/2021",
"cloud": "Azure Commercial",
"poNumber": "poNumber123"
},
"hasReadAccess": true,
"soldTo": {
"addressLine1": "Test Address",
"city": "City",
"companyName": "Enterprise Company",
"country": "US",
"postalCode": "00000-1111",
"region": "WA"
}
},
"type": "Microsoft.Billing/billingAccounts",
"systemData": {
"createdAt": "2023-01-04T22:39:34.2606750Z",
"lastModifiedAt": "2023-01-05T22:39:34.2606750Z"
}
}
]
}
Definitions
AccountStatus
Enumeration
The current status of the billing account.
| Value |
Description |
|
Active
|
|
|
Deleted
|
|
|
Disabled
|
|
|
Expired
|
|
|
Extended
|
|
|
New
|
|
|
Other
|
|
|
Pending
|
|
|
Terminated
|
|
|
Transferred
|
|
|
UnderReview
|
|
AccountSubType
Enumeration
The tier of the account.
| Value |
Description |
|
Enterprise
|
|
|
Individual
|
|
|
None
|
|
|
Other
|
|
|
Professional
|
|
AccountType
Enumeration
The type of customer.
| Value |
Description |
|
Business
|
|
|
ClassicPartner
|
|
|
Enterprise
|
|
|
Individual
|
|
|
Internal
|
|
|
Other
|
|
|
Partner
|
|
|
Reseller
|
|
|
Tenant
|
|
AgreementType
Enumeration
The type of agreement.
| Value |
Description |
|
EnterpriseAgreement
|
|
|
MicrosoftCustomerAgreement
|
|
|
MicrosoftOnlineServicesProgram
|
|
|
MicrosoftPartnerAgreement
|
|
|
Other
|
|
BillingAccount
Object
A billing account.
| Name |
Type |
Description |
|
id
|
string
|
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
A container for a list of resources
| Name |
Type |
Description |
|
nextLink
|
string
|
The link (url) to the next page of results.
|
|
value
|
BillingAccount[]
|
The list of resources.
|
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
|
EnrollmentDetails
|
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
|
RegistrationNumber
|
Describes the registration number of the organization linked with the billing account.
|
|
soldTo
|
SoldTo
|
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.
|
BillingAccountStatusReasonCode
Enumeration
Reason for the specified billing account status.
| Value |
Description |
|
Expired
|
|
|
ManuallyTerminated
|
|
|
Other
|
|
|
TerminateProcessing
|
|
|
Transferred
|
|
|
UnusualActivity
|
|
BillingRelationshipType
Enumeration
Identifies the billing relationships represented by a billing account. The billing relationship may be between Microsoft, the customer, and/or a third-party.
| Value |
Description |
|
CSPCustomer
|
|
|
CSPPartner
|
|
|
Direct
|
|
|
IndirectCustomer
|
|
|
IndirectPartner
|
|
|
Other
|
|
createdByType
Enumeration
The type of identity that created the resource.
| Value |
Description |
|
Application
|
|
|
Key
|
|
|
ManagedIdentity
|
|
|
User
|
|
EnrollmentDetails
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
|
The end date of the enrollment.
|
|
extendedTermOption
|
ExtendedTermOption
|
The billing account extension opted by the company.
|
|
indirectRelationshipInfo
|
IndirectRelationshipInfo
|
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
|
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.
|
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 |
|
Opted-In
|
|
|
Opted-Out
|
|
|
Other
|
|
IndirectRelationshipInfo
Object
Identifies the billing profile that is linked to another billing profile in indirect purchase motion.
| 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.
|
MarkupStatus
Enumeration
Markup status of enrollment, applicable only for indirect enrollments.
| Value |
Description |
|
Disabled
|
|
|
Locked
|
|
|
Other
|
|
|
Preview
|
|
|
Published
|
|
ProvisioningState
Enumeration
The provisioning state of the resource during a long-running operation.
| Value |
Description |
|
Canceled
|
|
|
Failed
|
|
|
New
|
|
|
Pending
|
|
|
Provisioning
|
|
|
Succeeded
|
|
RegistrationNumber
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.
|
SoldTo
Object
The address of the individual or organization that is responsible for the billing account.
| Name |
Type |
Description |
|
addressLine1
|
string
|
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
|
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.
|
SupportLevel
Enumeration
The support level offer associated with an enrollment.
| Value |
Description |
|
Developer
|
|
|
Other
|
|
|
Pro-Direct
|
|
|
Standard
|
|
systemData
Object
Metadata pertaining to creation and last modification of the resource.
| Name |
Type |
Description |
|
createdAt
|
string
|
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
|
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 |
|
Invalid
|
|
|
Other
|
|
|
Valid
|
|
TaxIdentifierType
Enumeration
The type of the tax identifier.
| Value |
Description |
|
BrazilCcmId
|
|
|
BrazilCnpjId
|
|
|
BrazilCpfId
|
|
|
CanadianFederalExempt
|
|
|
CanadianProvinceExempt
|
|
|
ExternalTaxation
|
|
|
IndiaFederalServiceTaxId
|
|
|
IndiaFederalTanId
|
|
|
IndiaPanId
|
|
|
IndiaStateCstId
|
|
|
IndiaStateGstINId
|
|
|
IndiaStateVatId
|
|
|
IntlExempt
|
|
|
LoveCode
|
|
|
MobileBarCode
|
|
|
NationalIdentificationNumber
|
|
|
Other
|
|
|
PublicSectorId
|
|
|
USExempt
|
|
|
VatId
|
|