---
title: "Get custom currency"
method: GET
path: "/openmeter/currencies/custom/{currencyId}"
tags: ["OpenMeter Currencies"]
---

# Get custom currency

`GET /openmeter/currencies/custom/{currencyId}`

Get a custom currency.

## Path parameters

- `currencyId` string, required — ULID (Universally Unique Lexicographically Sortable Identifier).

## Response `200`

CurrencyCustom response.

- BillingCurrencyCustom — 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.

## Other responses

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

---

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