Customers - List By Billing Profile

Reference

Service:: Billing

API Version:: 2019-10-01-preview

Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers?api-version=2019-10-01-preview

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers?api-version=2019-10-01-preview&$filter={$filter}&$skiptoken={$skiptoken}

URI Parameters

Name	In	Required	Type	Description
billingAccountName	path	True	string	The ID that uniquely identifies a billing account.
billingProfileName	path	True	string	The ID that uniquely identifies a billing profile.
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2019-10-01-preview.
$filter	query		string	May be used to filter the list of customers.
$skiptoken	query		string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

Responses

Name	Type	Description
200 OK	CustomerListResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

CustomersListByBillingProfile

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers?api-version=2019-10-01-preview

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000000",
      "name": "22000000-0000-0000-0000-000000000000",
      "type": "Microsoft.Billing/customers",
      "properties": {
        "displayName": "customer1"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000011",
      "name": "22000000-0000-0000-0000-000000000011",
      "type": "Microsoft.Billing/customers",
      "properties": {
        "displayName": "customer2"
      }
    }
  ]
}

Definitions

AzurePlan	Details of the Azure plan.
Customer	A partner's customer.
CustomerListResult	The list of customers.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ErrorSubDetails
Reseller	Details of the reseller.

AzurePlan

Details of the Azure plan.

Name	Type	Description
skuDescription	string	The sku description.
skuId	string	The sku id.

Customer

A partner's customer.

Name	Type	Description
id	string	Resource Id.
name	string	Resource name.
properties.displayName	string	The name of the customer.
properties.enabledAzurePlans	AzurePlan[]	Azure plans enabled for the customer.
properties.resellers	Reseller[]	The list of resellers for which an Azure plan is enabled for the customer.
type	string	Resource type.

CustomerListResult

The list of customers.

Name	Type	Description
nextLink	string	The link (url) to the next page of results.
value	Customer[]	The list of customers.

ErrorDetails

The details of the error.

Name	Type	Description
code	string	Error code.
details	ErrorSubDetails[]	The sub details of the error.
message	string	Error message indicating why the operation failed.
target	string	The target of the particular error.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
error	ErrorDetails	The details of the error.

ErrorSubDetails

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.
target	string	The target of the particular error.

Reseller

Details of the reseller.

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