Quotes
Create, finalize, accept, and cancel quotes that convert into subscriptions.
A quote presents a pricing proposal to a prospective customer before they commit to a subscription. Once accepted, VINR automatically converts the quote into a live subscription.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The quote objectAsk
idstringUnique identifier for the quote, e.g. qt_5Bw2xNjR.
customerstringExpandableThe ID of the customer this quote is for, e.g. cust_8aZ2. Expand to retrieve the full
customer object.
statusenumQuote lifecycle state: draft, open, accepted, or canceled.
amount_totalintegerTotal amount across all line items, in the smallest currency unit.
currencystringThree-letter ISO currency code, e.g. EUR.
expires_atintegerUnix timestamp after which the quote can no longer be accepted.
line_itemsarrayThe list of products and prices included in the quote. Each item has price, quantity, and
amount_subtotal.
createdintegerUnix timestamp of when the quote was created, e.g. 1716300000.
Create a quoteAsk
Create a quote in draft status. Add line_items referencing existing prices.
Retrieve a quoteAsk
Update a quoteAsk
Update a draft or open quote. Only description and expires_at can be changed.
Finalize a quoteAsk
Finalizing moves the quote from draft to open and makes it shareable with the customer.
Accept a quoteAsk
Accepting an open quote converts it into a live subscription
and moves the quote to accepted.
Cancel a quoteAsk
Canceling a draft or open quote prevents it from being accepted.
List quotesAsk
Related eventsAsk
quote.created, quote.finalized, quote.accepted, and quote.canceled. See Events.
