Update custom currency

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

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

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const customCurrencyResponse = await client.v1.credits.customCurrencies.update('currencyId');

console.log(customCurrencyResponse.data);

200

{
  "data": {
    "id": "cred-type-credits",
    "displayName": "Credits",
    "symbol": "CR",
    "description": "Prepaid usage credits",
    "units": {
      "singular": "credit",
      "plural": "credits"
    },
    "metadata": {},
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "archivedAt": null
  }
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

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-ID · string

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).

Path Parameters

currencyId · string · required

The reference ID of the custom currency

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Body

application/json

Request body for updating an existing custom currency. Only supplied fields are modified.

displayName · string

The display name of the custom currency

Maximum string length: 64

symbol · string | null

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

Maximum string length: 64

description · string | null

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

Maximum string length: 255

units · UnitsRequest · object

Singular and plural unit labels for a custom currency. Both fields are required when supplied.

Show child attributes

metadata · object

Additional metadata to attach to the custom currency

Show child attributes

Response

200

application/json

The updated custom currency object.

Response object

data · CustomCurrency · object · required

A custom currency used to denominate credit-based entitlements and pricing

Show child attributes