v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve the credit balance summary for a customer

Retrieves the credit balance summary for a customer.

get/v1/billing/credit_balance_summary

Query parameters

customerstring

The customer whose credit balance summary you're retrieving.

customer_accountstring

The account representing the customer whose credit balance summary you're retrieving.

expandstring[]

Specifies which fields in the response should be expanded.

credit_grantstring
type'applicability_scope' | 'credit_grant' required

The filter criteria for the credit balance summary.

Response

Successful response.

customer_accountstring nullable

The account the balance is for.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'billing.credit_balance_summary' required

String representing the object's type. Objects of the same type share the same value.