The Credit Balance Summary object

Attributes

object string, value is "billing.credit_balance_summary" String representing the object’s type. Objects of the same type share the same value.
balances array of objects The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.
customer string Expandable The customer the balance is for.
customer _ account nullable string The account the balance is for.
livemode boolean 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", "balances": [ { "available_balance": { "monetary": { "currency": "usd", "value": 1000 }, "type": "monetary" }, "ledger_balance": { "monetary": { "currency": "usd", "value": 1000 }, "type": "monetary" } } ], "customer": "cus_QsEHa3GKweMwih", "livemode": false}

Retrieve the credit balance summary for a customer

GET / v1 / billing / credit_balance_summary

Retrieves the credit balance summary for a customer.

Parameters

filter object Required The filter criteria for the credit balance summary.
customer string The customer whose credit balance summary you’re retrieving.
customer _ account string The account representing the customer whose credit balance summary you’re retrieving.

Returns

Returns the credit balance summary.

Response

{ "object": "billing.credit_balance_summary", "balances": [ { "available_balance": { "monetary": { "currency": "usd", "value": 1000 }, "type": "monetary" }, "ledger_balance": { "monetary": { "currency": "usd", "value": 1000 }, "type": "monetary" } } ], "customer": "cus_QsEHa3GKweMwih", "livemode": false}