Usage

Report usage events

Changed on

Reports raw usage events for event-based metering. Events are ingested asynchronously and aggregated into usage totals.

post/api/v1/events

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/events
  • 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 events were accepted for processing.

dataobject required

Empty success response confirming that events were successfully ingested and queued for processing by Stigg's metering system.

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