Credits - Get

Service:

Consumption

API Version:

2024-08-01

The credit summary by billingAccountId and billingProfileId.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/credits/balanceSummary?api-version=2024-08-01

URI Parameters

Name	In	Required	Type	Description
billingAccountId	path	True	string	BillingAccount ID
billingProfileId	path	True	string	Azure Billing Profile ID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	CreditSummary	Azure operation completed successfully.
204 No Content		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

CreditSummaryByBillingProfile

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/credits/balanceSummary?api-version=2024-08-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.consumption import ConsumptionManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-consumption
# USAGE
    python credit_summary_by_billing_profile.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 = ConsumptionManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.credits.get(
        billing_account_id="1234:5678",
        billing_profile_id="2468",
    )
    print(response)


# x-ms-original-file: 2024-08-01/CreditSummaryByBillingProfile.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

Go

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption/v2"
)

// Generated from example definition: 2024-08-01/CreditSummaryByBillingProfile.json
func ExampleCreditsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconsumption.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCreditsClient().Get(ctx, "1234:5678", "2468", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armconsumption.CreditsClientGetResponse{
	// 	CreditSummary: &armconsumption.CreditSummary{
	// 		Name: to.Ptr("balanceSummary1"),
	// 		Type: to.Ptr("Microsoft.Consumption/credits/balanceSummary"),
	// 		ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/credits/balanceSummary1"),
	// 		Properties: &armconsumption.CreditSummaryProperties{
	// 			BalanceSummary: &armconsumption.CreditBalanceSummary{
	// 				CurrentBalance: &armconsumption.Amount{
	// 					Currency: to.Ptr("USD"),
	// 				},
	// 				EstimatedBalance: &armconsumption.Amount{
	// 					Currency: to.Ptr("USD"),
	// 				},
	// 			},
	// 			BillingCurrency: to.Ptr("USD"),
	// 			CreditCurrency: to.Ptr("USD"),
	// 			ExpiredCredit: &armconsumption.Amount{
	// 				Currency: to.Ptr("USD"),
	// 			},
	// 			IsEstimatedBalance: to.Ptr(false),
	// 			PendingCreditAdjustments: &armconsumption.Amount{
	// 				Currency: to.Ptr("USD"),
	// 			},
	// 			PendingEligibleCharges: &armconsumption.Amount{
	// 				Currency: to.Ptr("USD"),
	// 			},
	// 			Reseller: &armconsumption.Reseller{
	// 				ResellerDescription: to.Ptr("Reseller information."),
	// 				ResellerID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1"),
	// 			},
	// 		},
	// 	},
	// }
}

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

Status code:

200

{
  "name": "balanceSummary1",
  "type": "Microsoft.Consumption/credits/balanceSummary",
  "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/credits/balanceSummary1",
  "properties": {
    "balanceSummary": {
      "currentBalance": {
        "currency": "USD",
        "value": 100
      },
      "estimatedBalance": {
        "currency": "USD",
        "value": 600
      }
    },
    "billingCurrency": "USD",
    "creditCurrency": "USD",
    "expiredCredit": {
      "currency": "USD",
      "value": 0
    },
    "isEstimatedBalance": false,
    "pendingCreditAdjustments": {
      "currency": "USD",
      "value": 500
    },
    "pendingEligibleCharges": {
      "currency": "USD",
      "value": 0
    },
    "reseller": {
      "resellerDescription": "Reseller information.",
      "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1"
    }
  }
}

Status code:

204

Definitions

Name	Description
amount	The amount plus currency .
AmountWithExchangeRate	The amount with exchange rate.
createdByType	The type of identity that created the resource.
CreditBalanceSummary	Summary of credit balances.
CreditSummary	A credit summary resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Reseller	The reseller properties.
systemData	Metadata pertaining to creation and last modification of the resource.

amount

Object

The amount plus currency .

Name	Type	Description
currency	string	Amount currency.
value	number (decimal)	Amount.

AmountWithExchangeRate

Object

The amount with exchange rate.

Name	Type	Description
currency	string	Amount currency.
exchangeRate	number (decimal)	The exchange rate.
exchangeRateMonth	integer (int32)	The exchange rate month.
value	number (decimal)	Amount.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

CreditBalanceSummary

Object

Summary of credit balances.

Name	Type	Description
currentBalance	amount	Current balance.
estimatedBalance	amount	Estimated balance.
estimatedBalanceInBillingCurrency	AmountWithExchangeRate	Estimated balance in billing currency.

CreditSummary

Object

A credit summary resource.

Name	Type	Description
eTag	string	eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.balanceSummary	CreditBalanceSummary	Summary of balances associated with this credit summary.
properties.billingCurrency	string	The billing currency.
properties.creditCurrency	string	The credit currency.
properties.eTag	string	The eTag for the resource.
properties.expiredCredit	amount	Expired credit.
properties.isEstimatedBalance	boolean	If true, the listed details are based on an estimation and it will be subjected to change.
properties.pendingCreditAdjustments	amount	Pending credit adjustments.
properties.pendingEligibleCharges	amount	Pending eligible charges.
properties.reseller	Reseller	Credit's reseller.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	A list of Tag.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

Reseller

Object

The reseller properties.

Name	Type	Description
resellerDescription	string	The reseller property description.
resellerId	string	The reseller property ID.

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.