Sign in

v69

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

Create custom currency

Creates a new custom currency in the environment.

post/api/v1/credits/custom-currencies

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

idstring required

The unique identifier for the new custom currency

displayNamestring required

The display name of the custom currency

symbolstring

The symbol used to represent the custom currency

descriptionstring

Description of the currency

metadataobject

Additional metadata to attach to the custom currency

Response

The newly created custom currency object.