Credit consumption

Consume credits asynchronously

Changed on

Consumes credits directly from customer wallets asynchronously. Consumptions are reconciled asynchronously into the credit balances.

post/api/v1/credits/consumption/async

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/credits/consumption/async
  • 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

Response

Confirmation that the credit consumptions were accepted for processing.

dataobject required

Confirmation that the credit consumptions were accepted for processing

Changes

    • warning

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

    • 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