Addon Entitlements4

Addons9

Auto recharge1

Bulk Import2

Contracts6

Coupons5

Credit consumption2

Credit grants3

Credit ledger1

Credit usage1

Custom currencies6

Customer Integrations5

Customers9

Data Export6

Entitlements2

Features6

Governance Assignments2

Governance Entities5

Governance Entitlements Check1

Governance Entity Types2

Governance Hierarchy1

Invoices1

Plan Entitlements4

Plans10

Products6

Promotional Entitlements3

Subscriptions14

Usage5

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.

Changes

Changed in 3 of the 115 revisions of this API.61

Jul 28, 2026913f273cc2f71See the full diff
- ●
  added the new ContractNotFound enum value to the code response property for the response status 404
  response-property-enum-value-added
Jul 23, 2026b876edd1a4fc5See the full diff
- ●
  added the new CreditOveragePriceCurrencyNotFound enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new InvalidCreditOverageBillingModel enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new OveragePriceNotSupportedOnAddon enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new OveragePriceRequiresUsageLimit enum value to the code response property for the response status 400
  response-property-enum-value-added
Jul 14, 2026213ee76acf121See the full diff
- ○
  endpoint added
  endpoint-added

Full history