Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Credit Balance Summary

Indicates the billing credit balance for billing credits granted to a customer.

Was this section helpful?YesNo
Retrieve the credit balance summary for a customer
GET/v1/billing/credit_balance_summary

The Credit Balance Summary object

Attributes

  • objectstring

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

  • balancesarray 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.

  • customerstringExpandable

    The customer the balance is for.

  • customer_accountnullable string

    The account the balance is for.

  • livemodeboolean

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

The Credit Balance Summary object
{
  "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": "",
  "livemode": false
}

Retrieve the credit balance summary for a customer

Retrieves the credit balance summary for a customer.

Parameters

  • filterobjectRequired

    The filter criteria for the credit balance summary.

  • customerstring

    The customer whose credit balance summary you’re retrieving.

  • customer_accountstring

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

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:" \
  -d customer= \
  -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": "",
  "livemode": false
}