---
title: "Update custom currency"
method: PATCH
path: "/api/v1/credits/custom-currencies/{currencyId}"
tags: ["Custom currencies"]
---

# Update custom currency

`PATCH /api/v1/credits/custom-currencies/{currencyId}`

Updates an existing custom currency. Only the supplied fields are modified.

## Path parameters

- `currencyId` string, required

## Headers

- `X-ACCOUNT-ID` string
- `X-ENVIRONMENT-ID` string

## Request body

- UpdateCustomCurrencyRequestDto — Request body for updating an existing custom currency. Only supplied fields are modified.
  - `displayName` string — The display name of the custom currency
  - `symbol` string, nullable — The symbol used to represent the custom currency. Send an empty string to clear.
  - `description` string, nullable — A human-readable description of the custom currency. Send an empty string to clear.
  - `units` object — Singular and plural unit labels for a custom currency. Both fields are required when supplied.
    - `singular` string, required — Singular form of the unit label
    - `plural` string, required — Plural form of the unit label
  - `metadata` object, nullable — Additional metadata to attach to the custom currency

## Response `200`

The updated custom currency object.

- CustomCurrencyResponseDto — Response object
  - `data` object, required — A custom currency used to denominate credit-based entitlements and pricing
    - `id` string, required — The unique identifier for the custom currency
    - `displayName` string, required — The display name of the custom currency
    - `symbol` string, nullable, required — The symbol used to represent the custom currency
    - `description` string, nullable, required — Description of the currency
    - `units` object, nullable, required — Singular and plural unit labels for a custom currency
      - `singular` string, nullable, required — Singular form of the unit label
      - `plural` string, nullable, required — Plural form of the unit label
    - `metadata` object, required — Metadata associated with the entity
    - `createdAt` string, date-time, required — Timestamp of when the record was created
    - `updatedAt` string, date-time, required — Timestamp of when the record was last updated
    - `archivedAt` string, date-time, nullable, required — Timestamp of when the record was deleted

## Other responses

- `400` — bad request.
- `401` — User is not authenticated.
- `403` — User is not allowed to access this resource.
- `404` — CustomCurrency not found.
- `429` — Too many requests.

---

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