Skip to main content
GET
Preview every line an order would bill

Authorizations

Authorization
string
header
required

Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.

Path Parameters

productKey
string
required

Query Parameters

entity_type
enum<string>
required
Available options:
llc,
c_corp
state
string
required

The company's formation state, as a 2-letter code.

Pattern: ^[A-Za-z]{2}$
pre_existing
boolean

Preview for a pre-existing company you bring in. Defaults to false.

owners_count
integer

How many owners the company has. Defaults to 1.

Required range: 1 <= x <= 100
has_ein
boolean

Whether 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).

incorporated
boolean

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.

object
enum<string>
required

Entity name.

Available options:
price_preview
product_key
string
required
Example:

"annual_state_filing"

unit_amount
integer<int64>
required

Your price for this product and profile, in cents - your override or a matching price rule when one applies, otherwise the default.

currency
string
required
Example:

"usd"

estimate
enum<boolean>
required

Always true - amounts here are resolved now. The order's own resolution governs and is frozen on the order.

Available options:
true
display_name
string
interval
enum<string>
Available options:
one_time,
monthly,
yearly
overridden
boolean

True when your negotiated sheet priced this product.

applied_rule
string

The price rule that decided unit_amount for this profile, when one matched - why this profile pays this amount.

options
object[]

The product's variants with each value's own effective amount - a chosen value's amount replaces unit_amount.

fees
object[]

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.