OpenMeter Currencies

List cost bases

Changed on

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

List cost bases for a currency. For custom currencies, there can be multiple cost bases with different effective_from dates.

get/v3/openmeter/currencies/custom/{currencyId}/cost-bases

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/currencies/custom/{currencyId}/cost-bases
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

currencyIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

fiat_codestring

Filter cost bases by fiat currency code.

Filter cost bases returned in the response.

To filter cost bases by fiat currency code add the following query param: filter[fiat_code]=USD

{
  "fiat_code": "USD"
}
sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

Response

Page paginated response.

Example response

{
  "data": [
    {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "fiat_code": "USD",
      "effective_from": "2023-01-01T01:01:01.001Z",
      "effective_to": "2023-01-01T01:01:01.001Z",
      "created_at": "2023-01-01T01:01:01.001Z"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

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

  • 59663dd13a10Revision changes
    • info

      endpoint added