Skip to main content
POST
Estimate billing
Returns a plan recommendation and estimated monthly cost based on your expected usage. This is a public endpoint — no authentication is required. Use it to help users choose the right plan during onboarding or on a pricing page.

Request body

string
ISO 3166-1 alpha-2 country code (e.g., US, NG). Used to determine provider routing and regional pricing.
integer
Expected number of verifications per month.
integer
Number of issuers your organization requires.
integer
Number of webhook endpoints you plan to configure.
integer
Expected storage in gigabytes.
integer
Number of team members.
string
Optional contract type: ENTERPRISE_CONTRACT or GOVERNMENT_PROCUREMENT. When set, the estimate automatically recommends the Enterprise plan.

Response

The plan that best fits your requirements (e.g., plan_starter, plan_business).
Add-ons the estimate suggests based on your needs (e.g., extra seats beyond the plan limit).
number
Projected monthly cost in USD.
string
Currency code (USD).
string[]
Notes about the estimate (e.g., volume discounts, custom pricing).
object
Payment provider information for the given country.
For a detailed line-item breakdown of costs, use the projected invoice endpoint instead.

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
plan
string
required

Target plan identifier

addons
string[]

Optional addon identifiers

Response

Cost estimate

subtotal
number
tax
number
total
number
currency
string
proration
number