Retrieve the credit balance summary for a customer

Retrieves the credit balance summary for a customer.

Parameters

customerstring
The customer for which to fetch credit balance summary.

filterobjectRequired
The filter criteria for the credit balance summary.

customer_accountstringPreview feature
The account for which to fetch credit balance summary.

Returns

Returns the credit balance summary.

GET /v1/billing/credit_balance_summary

curl -G https://api.stripe.com/v1/billing/credit_balance_summary \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Version: 2025-04-30.basil" \
  -d customer=cus_QsEHa3GKweMwih \
  -d "filter[type]"=credit_grant \
  -d "filter[credit_grant]"=credgr_test_61R9rvFh1HgrFIoCp41L6nFOS1ekDCeW

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
}

Retrieve the credit balance summary for a customer

Parameters

customerstring

filterobjectRequired

customer_accountstringPreview feature

Returns