Available Balances - Get

The available credit balance for a billing profile. This is the balance that can be used for pay now to settle due or past due invoices. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default?api-version=2020-05-01

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 2020-05-01.

Responses

Name Type Description
200 OK

AvailableBalance

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

AvailableBalanceByBillingProfile

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default?api-version=2020-05-01

Sample Response

{
  "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default",
  "name": "default",
  "type": "Microsoft.Billing/billingAccounts/billingProfiles/availableBalance",
  "properties": {
    "amount": {
      "currency": "USD",
      "value": 500
    }
  }
}

Definitions

Name Description
Amount

The amount.

AvailableBalance

The latest Azure credit balance. This is the balance available for pay now.

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

Amount

The amount.

Name Type Description
currency

string

The currency for the amount value.

value

number

Amount value.

AvailableBalance

The latest Azure credit balance. This is the balance available for pay now.

Name Type Description
id

string

Resource Id.

name

string

Resource name.

properties.amount

Amount

Balance amount.

type

string

Resource type.

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.