Preview every line an order would bill
Resolve one product for a company profile BEFORE creating anything: your own amount (override, matching price rule, or default - applied_rule says which), each option value’s effective amount, and every pass-through government or state fee line at today’s amounts. Use it to price your own offer with no surprises. The order itself resolves again and freezes what it billed on the order’s fees. Formation keys also carry the state’s filing fee.
Authorizations
Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.
Path Parameters
Query Parameters
llc, c_corp The company's formation state, as a 2-letter code.
^[A-Za-z]{2}$Preview for a pre-existing company you bring in. Defaults to false.
How many owners the company has. Defaults to 1.
1 <= x <= 100Whether the company already holds an EIN. A price rule may condition on it, so state it to preview the same amount the order resolves. Defaults to false (a fresh formation).
Whether the company is already incorporated (holds a formation date). A price rule may condition on it. Defaults to false.
Response
The resolved preview.
Every line an order for this product COULD put on your statement, resolved for the stated company profile. Amounts are today's - the order resolves them again and freezes what it billed on the order's own fees - so treat this as an estimate, never a quote.
Entity name.
price_preview "annual_state_filing"
Your price for this product and profile, in cents - your override or a matching price rule when one applies, otherwise the default.
"usd"
Always true - amounts here are resolved now. The order's own resolution governs and is frozen on the order.
true one_time, monthly, yearly True when your negotiated sheet priced this product.
The price rule that decided unit_amount for this profile, when one matched - why this profile pays this amount.
The product's variants with each value's own effective amount - a chosen value's amount replaces unit_amount.
The pass-through government and state fee lines an order would bill beside the product, at today's amounts. A fee the state does not charge (or whose price is not configured yet) produces no line.