STstiggio
Custom currencies

Create custom currency

Changed on

Creates a new custom currency in the environment.

post/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

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

Request body

idstring required

The unique identifier for the new custom currency

displayNamestring required

The display name of the custom currency

symbolstring

The symbol used to represent the custom currency

descriptionstring

Description of the currency

metadataobject

Additional metadata to attach to the custom currency

Response

The newly created custom currency object.

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

    • info

      removed the InvoicePreviewNotAvailableForDraftContract enum value from the response property for the response status

  • 58bb216ff8ceRevision changes
    • warning

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