OpenMeter Customers

Get a customer's credit balance

Changed on

Get a credit balance.

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

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/customers/{customerId}/credits/balance
  • Auth: none declared

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. Historical responses return live as zero because live charge impacts are only available for current balances.

Response

CreditBalances response.

retrieved_atstring date-time required

RFC3339 formatted date-time string in UTC.

Example response

{
  "retrieved_at": "2023-01-01T01:01:01.001Z",
  "balances": [
    {
      "currency": "USD",
      "custom_currency": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      }
    }
  ]
}

Changes

  • v395c5286383d4Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

  • v3354e2b4efca6Revision changes
    • info

      added the optional property // to the response with the status