Skip to main content
GET
/
api
/
v1
/
credits
/
custom-currencies
/
{currencyId}
/
associated-entities
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 response = await client.v1.credits.customCurrencies.listAssociatedEntities('currencyId');

console.log(response.data);
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "displayName": "<string>"
    }
  ]
}

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_|.-]*$

Response

A list of entities currently referencing the custom currency.

List of entities (plans or addons) that reference a custom currency

data
CustomCurrencyAssociatedEntity · object[]
required