STstiggio
Usage

Estimate usage credit cost

Changed on

Estimates the credit cost of a usage report without recording it. Returns the estimated cost per credit currency, the current balance, and the balance after the estimated consumption.

post/api/v1/usage/estimate

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/usage/estimate
  • 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

valueinteger required

The value to report for usage

featureIdstring required

Feature id

customerIdstring required

Customer id

resourceIdstring nullable

Resource id

updateBehavior'DELTA' | 'SET'

The method by which the usage value should be updated

dimensionsobject

Additional dimensions for the usage report

Response

The credit cost estimation, including per-currency costs, balances, and warnings.

Changes

  • 913f273cc2f7Revision changes
    • warning

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

  • 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