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

The Credit Balance Summary object 

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.

    • balances.available_balanceobject

      Billing credit balance that is available for use by the customer. This is equal to ledger balance less any expired billing credits for which expiration ledger transaction entries haven’t yet been committed to the ledger. In future, this will also take into account any usage that hasn’t yet been invoiced for a customer.

      • balances.available_balance.monetarynullable object

        The monetary amount.

        • balances.available_balance.monetary.currencystring

          Three-letter ISO currency code, in lowercase. Must be a supported currency.

        • balances.available_balance.monetary.valueinteger

          A positive integer representing the amount.

      • balances.available_balance.typeenum

        The type of this amount. We currently only support monetary billing credits.

        Possible enum values
        monetary

        The amount is a monetary amount.

    • balances.ledger_balanceobject

      Reflects billing credit balance taking into account ledger transactions that have been committed to the ledger.

      • balances.ledger_balance.monetarynullable object

        The monetary amount.

        • balances.ledger_balance.monetary.currencystring

          Three-letter ISO currency code, in lowercase. Must be a supported currency.

        • balances.ledger_balance.monetary.valueinteger

          A positive integer representing the amount.

      • balances.ledger_balance.typeenum

        The type of this amount. We currently only support monetary billing credits.

        Possible enum values
        monetary

        The amount is a monetary amount.

  • customerstringExpandable

    The customer the balance is for.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

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": "cus_QsEHa3GKweMwih",
  "livemode": false
}