Preview a product's price for an existing company
Resolve what a product would bill for THIS company, read from the company’s own attributes - no profile query params to state or get wrong. It resolves against the same facts the order does (entity type, state, owner count, whether it holds an EIN, whether it is incorporated), so it cannot quote a price the order would not charge. Returns 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 GET /products/{productKey}/price-preview instead to price a product for a hypothetical company before one exists.
Authorizations
Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.
Path Parameters
ID of the company.
^cmp_[0-9A-Za-z]{22}$Response
The resolved preview for this company.
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.