---
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`

**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.
    - `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` string, required — Fiat or custom currency code.
    - `live` string, required — Credits available after applying currently live charge impacts.
    - `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

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/revisions/0261aef4b1e2/schema)