OpenMeter Customers

List credit transactions

Changed on

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

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/v3/openmeter/customers/{customerId}/credits/transactions

Request

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

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'

Filter credit transactions by type.

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

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • info

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