List ledger account balances

Eventually Consistent

Returns a paginated list of real-time credit balance snapshots for a subscription. Each item in the list is a ledger_account_balance object, identified by a unique combination of subscription_id, unit_id, unit_type.

Sample Request

Sample Result[JSON]

URL Format

GET https://[site].chargebee.com/api/v2/ledger_account_balances

Input Parameters

limit

optional, integer, default=10, min=1, max=100

Specifies the maximum number of resources to return per page.

Default and Hard Cap

Optional parameter; if omitted, a server-defined default is applied.
Values exceeding the server's maximum limit are capped (clamped) to the allowed maximum.

Example → limit = "50"

offset

optional, string, max chars=1000

Opaque cursor indicating the current position in the result set for pagination.

Behavior

To fetch the next page, pass the next_offset value returned in the previous response.
The value is opaque and must not be parsed, modified, or constructed manually.

Example → offset = "["1771176208000","96000000006"]"

Filter Params

For operator usages, see the Pagination and Filtering section.

subscription_id[<operator>]

required, string filter

Filters results by subscription identifier. This is the subscription whose credit grant balances you are listing.

Supported operators : is

Example → subscription_id[is] = "1mGETgZVF2umUZq"

Supported operators: is

unit_id[<operator>]

optional, string filter

Filters results by unit identifier. For example, a credit unit id such as ai_credits.

Supported operators : is

Example → unit_id[is] = "ai_credits"

Supported operators: is

Returns

next_offset

optional, string, max chars=1000

This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter offset.

ledger_account_balance

Ledger account balance object

Resource object representing a credit balance snapshot. The response is the standard Chargebee list envelope: { "list": [{ "ledger_account_balance": { ... } }, ...], "next_offset": "..." }, where each list item wraps a single ledger_account_balance under its resource name.