STstiggio
Custom currencies

Get a list of custom currencys

Changed on

Retrieves a paginated list of custom currencies in the environment. Archived currencies are excluded by default; pass status=ARCHIVED (or status=ACTIVE,ARCHIVED) to include them.

get/api/v1/credits/custom-currencies

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/credits/custom-currencies
  • Auth
    API key in header X-API-KEY

Query parameters

afterstring uuid

Return items that come after this cursor

beforestring uuid

Return items that come before this cursor

limitinteger

Maximum number of items to return

statusstring[]

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

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

A paginated list of custom currency objects.

Changes

  • b876edd1a4fcRevision changes
    • warning

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

    • warning

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

    • warning

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

    • warning

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

    • warning

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status

  • 58bb216ff8ceRevision changes
    • warning

      added the new GovernanceNotEnabled enum value to the response property for the response status