v61

OpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB

OpenMeter Customers

Get a customer's credit balance

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

Get a credit balance.

get/v3/openmeter/customers/{customerId}/credits/balance

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

timestampstring date-time

RFC3339 formatted date-time string in UTC.

Example:2023-01-01T01:01:01.001Z

Return the credit balance as of this timestamp.

Defaults to the current time.

Response

CreditBalances response.

retrieved_atstring date-time required

The timestamp of the balance retrieval.

Example response

{
  "retrieved_at": "2023-01-01T01:01:01.001Z",
  "balances": [
    {
      "currency": "USD",
      "live": "200.00",
      "settled": "150.00",
      "pending": "50.00"
    }
  ]
}