---
title: "Get a customer's credit balance"
method: GET
path: "/v3/openmeter/customers/{customerId}/credits/balance"
tags: ["OpenMeter Customers"]
---

# Get a customer's credit balance

`GET /v3/openmeter/customers/{customerId}/credits/balance`

## Request

- Base URL: `https://global.api.konghq.com`
- URL: `https://global.api.konghq.com/v3/openmeter/customers/{customerId}/credits/balance`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer

**Pre-release Endpoint**
This endpoint is currently in beta and is subject to change.

Get a credit balance.

## Path parameters

- `customerId` string, required: ULID (Universally Unique Lexicographically Sortable Identifier).

## Query parameters

- `timestamp` string, date-time: [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
- `filter` GetCreditBalanceParamsFilter: Filter options for getting a credit balance.
  - `currency` object: Filter credit balance by currency code. When historical custom currencies reuse a code, each managed currency is returned as a separate balance row.
    - `eq` string
    - `oeq` string, required
    - `neq` string, required
  - `feature_key` object: Filter credit balance by feature key. Omit to return the total portfolio value. Use `exists=false` to return only unrestricted balance.
    - `eq` string
    - `contains` string, required
    - `ocontains` string, required
    - `oeq` string, required
    - `neq` string, required

## Response `200`

CreditBalances response.

- BillingCreditBalances: The balances of the credits of a customer.
  - `retrieved_at` string, date-time, required: The timestamp of the balance retrieval.
  - `balances` CreditBalance[], required: The balances by currencies.
    - `currency` union, required: Fiat or custom currency code.
      - string: Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience.
      - string: Custom currency code. It should be a unique code but not conflicting with any existing fiat currency codes.
    - `custom_currency` object: Managed currency reference. Present only for custom currencies.
      - `id` string, required: ULID (Universally Unique Lexicographically Sortable Identifier).
    - `live` string, required: Credits available after applying currently live charge impacts. Always zero for historical balance queries using the `timestamp` parameter because live charge impacts cannot be reconstructed historically.
    - `settled` string, required: Credits that have been booked on the ledger as of the balance timestamp.
    - `pending` string, required: Credits that have been granted but are not yet written to the ledger, or are written to the ledger with a future booked time.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-10-15** `7aab863a6daa`: 1 breaking, 2 warning
  - added `#/components/schemas/InvalidParameterMinimumTime, #/components/schemas/InvalidParameterMaximumTime` to the `invalid_parameters/items/` response property `oneOf` list for the response status `400`
  - added the new `key_invalid` enum value to the `invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
  - added the new `unique` enum value to the `invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
- **2026-09-25** `68d43091b84d`: 3 warning, 1 info
  - added the new `400.00` enum value to the `status` response property for the response status `400`
  - added the new `403.00` enum value to the `status` response property for the response status `403`
  - added the new `404.00` enum value to the `status` response property for the response status `404`
  - added the optional property `balances/items/custom_currency` to the response with the `200` status
- **2026-09-18** `f324fb7610e4`: 7 breaking, 25 info
  - the response's body type changed from no type to `object` for status `400`
  - the response's body type changed from no type to `object` for status `403`
  - the response's body type changed from no type to `object` for status `404`
  - the `balances/items/currency` response property's maxLength was unset from `3` for the response status `200`
  - …28 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/kong/apis/konnect-api-go-sdk/changes/v3/openmeter/customers/:customerId/credits/balance/get.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc.dev/kong/apis/konnect-api-go-sdk/revisions/7aab863a6daa?raw)