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 

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.

  • 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
}

Retrieve the credit balance summary for a customer 

Retrieves the credit balance summary for a customer.

Parameters

  • customerstringRequired

    The customer for which to fetch credit balance summary.

  • filterobjectRequired

    The filter criteria for the 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:" \
  -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
}

Credit Balance Transaction 

A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.

Endpoints

Plans 

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single “gold” product that has plans for $10/month, $100/year, €9/month, and €90/year.

Related guides: Set up a subscription and more about products and prices.

Endpoints

License Fee Subscriptions v2

A License Fee Subscription links one License Fee to a specific Billing Cadence. While the License Fee Subscription is active, Stripe will bill the payer according to the License Fee’s pricing and the quantity subscribed.

Learn more about calling API v2 endpoints.