Preview Price

POST

/api/:account_id/prices/preview

Preview what a price configuration would charge for a given quantity.

Pure computation through the shared pricing engine — no rows are created. The same engine powers real charging, so this preview cannot disagree with what the customer is actually billed.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

billing_schemeenumRequired

Pricing scheme to preview

quantitydoubleOptional>=0Defaults to 1

Quantity of units to price (or projected metered usage)

unit_amount_atominteger or nullOptional>=0

Per-unit amount in atoms (for per_unit pricing)

quantity_divisorinteger or nullOptional>=1

Package size — units per billable package

tier_amount_infoobject or nullOptional

Tier configuration (for tiered pricing)

Response

Successful Response

quantitydouble

The quantity that was priced

total_amount_atominteger

Total charge in atoms (smallest currency unit)

breakdownlist of objects

Per-tier breakdown (empty for per_unit pricing)

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/prices/preview \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"billing_scheme": "per_unit"
>	}'

1	{
2	"quantity": 1.1,
3	"total_amount_atom": 1100,
4	"breakdown": [
5	{
6	"units_from": 1,
7	"units_in_tier": 1,
8	"unit_amount_atom": 1000,
9	"flat_amount_atom": 100,
10	"tier_amount_atom": 1100,
11	"units_to": 1
12	}
13	]
14	}