Custom currencies
Archive custom currency
Archives a custom currency. Fails if the currency is still associated with any active plan or addon — use the associated-entities endpoint first to inspect dependencies.
post/api/v1/credits/custom-currencies/{currencyId}/archive
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).
Response
The archived custom currency object.