v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB

Usage

Estimate usage credit cost

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

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.