Skip to main content
POST
/
v1
/
billing
/
projected-invoice
Project next invoice
curl --request POST \
  --url https://api.truthlocks.com/v1/billing/projected-invoice \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "plan": "<string>"
}
'
{
  "projected_total": 123,
  "currency": "<string>",
  "period_start": "<string>",
  "period_end": "<string>",
  "line_items": [
    {}
  ]
}
POST /v1/billing/projected-invoice
Returns a line-item invoice projection based on the usage volumes you provide. This is a public endpoint — no authentication is required. Use it for pricing calculators, cost forecasting, or pre-sales tools. Regional pricing adjustments are applied when you include a country_code.

​
Request body

​
mints
integer
required
Number of attestation mints to include in the projection.
​
verifications
integer
required
Number of verifications to include in the projection.
​
country_code
string
ISO 3166-1 alpha-2 country code for regional pricing adjustment (e.g., US, NG, KE). Defaults to Tier 1 (global) rates if omitted.
​
plan_key
string
Plan identifier to include the platform fee in the projection (e.g., plan_starter, plan_business). If omitted, the platform fee is excluded.

​
Response

​
line_items
object[]
Breakdown of projected charges.
​
subtotal
integer
Usage charges subtotal in cents (before platform fee).
​
total
integer
Total projected cost in cents (usage + platform fee).
​
currency
string
Currency code (USD).
​
rates_used
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
​
plan
string

Optional plan override for projection

Response

Projected invoice

​
projected_total
number
​
currency
string
​
period_start
string
​
period_end
string
​
line_items
object[]