Skip to main content
GET
/
api
/
v1
/
credits
/
custom-currencies
JavaScript
import Stigg from '@stigg/typescript';

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

// Automatically fetches more pages as needed.
for await (const customCurrencyListResponse of client.v1.events.credits.customCurrencies.list()) {
  console.log(customCurrencyListResponse.id);
}
{
  "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
    }
  ],
  "pagination": {
    "next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
    "prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-KEY
string
header
required

Server API Key

Query Parameters

after
string<uuid>

Return items that come after this cursor

before
string<uuid>

Return items that come before this cursor

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
status
enum<string>[]

Filter by custom currency status. Supports comma-separated values (e.g., ACTIVE,ARCHIVED). Defaults to ACTIVE.

Available options:
ACTIVE,
ARCHIVED

Response

A paginated list of custom currency objects.

Response list object

data
CustomCurrency · object[]
required
pagination
object
required

Pagination metadata including cursors for navigating through results