OpenMeter Customers

List credit transactions

Changed on

List credit transactions for a customer.

Returns an immutable, chronological record of credit movements: funded credits and consumed credits. Transactions are returned in reverse chronological order by default.

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

Request

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

Path parameters

customerIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

sizeinteger

The number of items to include per page.

afterstring

Request the next page of data, starting with the item after this parameter.

beforestring

Request the previous page of data, starting with the item before this parameter.

type'funded' | 'consumed' | 'expired' | 'voided'

The type of the credit transaction.

  • funded: Credit granted and available for consumption.
  • consumed: Credit consumed by usage or fees.
  • expired: Credit removed because it expired before being used.
  • voided: Credit removed because the grant was voided before being used.

Filter credit transactions returned in the response.

{
  "currency": "USD"
}

Response

Cursor paginated response.

Example response

{
  "data": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "labels": {
        "env": "test"
      },
      "created_at": "2023-01-01T01:01:01.001Z",
      "booked_at": "2023-01-01T01:01:01.001Z",
      "currency": "USD",
      "custom_currency": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      }
    }
  ],
  "meta": {
    "page": {
      "size": 10
    }
  }
}

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