---
title: "List currencies"
method: GET
path: "/openmeter/currencies"
tags: ["OpenMeter Currencies"]
---

# List currencies

`GET /openmeter/currencies`

List currencies supported by the billing system.

## Query parameters

- `page` object
  - `size` integer — The number of items to include per page.
  - `number` integer — The page number.
- `sort` string — The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').
- `filter` ListCurrenciesParamsFilter — Filter options for listing currencies.
  - `type` 'fiat' | 'custom' — Currency type for custom currencies. It should be a unique code but not conflicting with any existing standard currency codes.
  - `code` union — Filters on the given string field value by either exact or fuzzy match. All properties are optional; provide exactly one to specify the comparison.
    - string
    - object
      - `eq` string — Value strictly equals the given string value.
      - `neq` string — Value does not equal the given string value.
      - `contains` string — Value contains the given string value (fuzzy match).
      - `ocontains` string — Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.
      - `oeq` string — Returns entities that exact match any of the comma-delimited phrases in the filter string.
      - `gt` string — Value is greater than the given string value (lexicographic compare).
      - `gte` string — Value is greater than or equal to the given string value (lexicographic compare).
      - `lt` string — Value is less than the given string value (lexicographic compare).
      - `lte` string — Value is less than or equal to the given string value (lexicographic compare).
      - `exists` boolean — When true, the field must be present (non-null); when false, the field must be absent (null).
- `expand` BillingCurrencyExpand[]

## Response `200`

Page paginated response.

- CurrencyPagePaginatedResponse — Page paginated response.
  - `data` BillingCurrency[], required
    - union — Fiat or custom currency.
      - object — Currency describes a currency supported by the billing system.
        - `type` 'fiat', required — The type of the currency.
        - `name` string, required — The name of the currency. It should be a human-readable string that represents the name of the currency, such as "US Dollar" or "Euro".
        - `symbol` string — The symbol of the currency. It should be a string that represents the symbol of the currency, such as "$" for US Dollar or "€" for Euro.
        - `precision` integer, required — The precision of the currency. It should be a number that represents the number of decimal places used for the currency, such as 2 for US Dollar or Euro.
        - `decimal_mark` string, required — The decimal mark for the currency. It should be a string that represents the decimal mark of the currency, such as "." for US Dollar or "," for Euro.
        - `thousand_separator` string, required — The thousand separator for the currency. It should be a string that represents the thousand separator of the currency, such as "," for US Dollar or "." for Euro.
        - `code` string, required — Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience.
      - object — Describes custom currency.
        - `type` 'custom', required — The type of the currency.
        - `name` string, required — The name of the currency. It should be a human-readable string that represents the name of the currency, such as "US Dollar" or "Euro".
        - `symbol` string — The symbol of the currency. It should be a string that represents the symbol of the currency, such as "$" for US Dollar or "€" for Euro.
        - `precision` integer, required — The precision of the currency. It should be a number that represents the number of decimal places used for the currency, such as 2 for US Dollar or Euro.
        - `decimal_mark` string, required — The decimal mark for the currency. It should be a string that represents the decimal mark of the currency, such as "." for US Dollar or "," for Euro.
        - `thousand_separator` string, required — The thousand separator for the currency. It should be a string that represents the thousand separator of the currency, such as "," for US Dollar or "." for Euro.
        - `id` string, required — ULID (Universally Unique Lexicographically Sortable Identifier).
        - `code` string, required — Custom currency code. It should be a unique code but not conflicting with any existing fiat currency codes.
        - `created_at` string, date-time, required — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
        - `cost_basis` BillingCostBasis[] — The list of active and scheduled cost bases for the custom currency. Expired and deleted cost bases are excluded.
          - `id` string, required — ULID (Universally Unique Lexicographically Sortable Identifier).
          - `fiat_code` string, required — Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience.
          - `rate` string, required — Numeric represents an arbitrary precision number.
          - `effective_from` string, date-time — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
          - `effective_to` string, date-time — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
          - `created_at` string, date-time, required — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
  - `meta` PaginatedMeta, required — returns the pagination information
    - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/openmeterio/apis/openmeter-and-konnect-metering-billing-api.md) · [All operations](https://skmtc.net/openmeterio/apis/openmeter-and-konnect-metering-billing-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openmeterio/openmeter-and-konnect-metering-billing-api/revisions/9bca44e2d61d/schema)