Skip to main content
POST
Project next invoice
Returns a line-item invoice projection based on the usage volumes you provide. Authentication is required. Use your workspace API key. Use it for pricing calculators, cost forecasting, or pre-sales tools. Regional pricing adjustments are applied when you include a country_code. This endpoint uses the standard rate card, not a tenant’s negotiated agreement. Provide expected billable quantities; this calculator does not deduct free allowances or classify sandbox activity. Volume pricing is graduated. Each band prices only the operations in that band. The response identifies billing_model: "pay_per_use", volume_pricing: "graduated", amount_unit: "cents", and estimate_only: true. An estimate does not create or charge an invoice. Missing, overlapping, or incomplete rate definitions return 422 invalid_pricing; unsafe quantities and unknown plans return 400 bad_request. The exact applied prices are in line_items. The convenience rates_used scalar fields are retained for compatibility with flat rate cards; they are not a blended price and must not be multiplied across volume bands.

Response

object[]
Breakdown of projected charges.
integer
Usage charges subtotal in cents (before platform fee).
integer
Total projected cost in cents (usage + platform fee).
string
Rate-card currency code (currently USD).
object
The rates applied to this projection.
All amounts are in cents. Divide by 100 to convert to dollars. Regional multipliers apply automatically when you include a country_code.

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
country_code
string
mints
integer
Required range: 0 <= x <= 1000000000
plan_key
string
verifications
integer
Required range: 0 <= x <= 1000000000

Response

Projected invoice

total
integer
subtotal
integer
amount_unit
enum<string>
Available options:
cents
billing_model
enum<string>
Available options:
pay_per_use
volume_pricing
enum<string>
Available options:
graduated
estimate_only
boolean
currency
string
line_items
object[]