Skip to main content
POST
Simulate a proposed charge set (read-only)

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Body

application/json
currency
string

ISO code; defaults to the plan's first price currency.

subscription_id
string<uuid>

Optional: fills usage for metrics without an explicit entry.

charges
object[]
usage
object[]

Response

The pre-tax pricing simulation with a balanced GL preview.

data
object