v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB

Custom currencies

Update custom currency

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

patch/api/v1/credits/custom-currencies/{currencyId}

Path parameters

currencyIdstring required

The reference ID of the custom currency

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

displayNamestring

The display name of the custom currency

symbolstring nullable

The symbol used to represent the custom currency. Send an empty string to clear.

descriptionstring nullable

A human-readable description of the custom currency. Send an empty string to clear.

metadataobject nullable

Additional metadata to attach to the custom currency

Response

The updated custom currency object.