Quote a product and get a payment link
Price a product for a buyer and get a link where they can pay.
How it works
- Send the buyer's answers. The easiest way to build this request is to fill in the
quoteTemplatefromGET /buyers/{buyerId}/products/{productId}. - Send the buyer to the
paymentUrlin the response. - When they've paid, the purchase is created and its certificates are issued, usually within seconds. Find it with
GET /purchases?quoteId=and the quote'sid.
Nothing is bought until the buyer pays. Each call makes a new payment page: send an Idempotency-Key so a retry after a timeout gets the first quote back instead of a second one.
If something is wrong, you get a 400. error.details lists every problem, each naming the question it's about, so you can fix them all at once.
Authorization
SecretKey Your secret API key from the developer portal (API Keys). Keep it on your server: never put it in browser or mobile code.
In: header
Header Parameters
The API version you built against, as a date. Send it on every request. Without it you get the oldest
version still supported. An unknown version is 400 unsupported_version.
"2026-11-20"Value in
- "2026-11-20"
Any unique string up to 255 characters (a UUID, or your order id), no spaces. A retry with the same key and the
same body within 24 hours gets the first answer back, with Idempotent-Replayed: true, and nothing is done twice.
The same key with a different body is 422 idempotency_key_reused; while the first request is still running it
is 409 idempotency_in_progress. After a 4xx nothing was done and the key is free for a corrected retry. After
a 5xx or no answer the request may have been done, so the key answers 409 idempotency_outcome_unknown:
check, then use a new key.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/quotes" \ -H "Content-Type: application/json" \ -d '{ "buyerId": "9f1c4e2a-3b7d-4c1e-8f2a-5d6b7c8e9f01", "productId": 105, "startDate": "2026-12-01", "units": 3, "timeZone": "America/Chicago", "answers": [ { "questionId": 286, "value": "1FUJGLDR7CLBP8834" }, { "questionId": 287, "value": "2021" }, { "questionId": 288, "value": "Freightliner" }, { "questionId": 289, "value": "85000" }, { "questionId": 291, "value": "Acme Freight LLC" } ] }'{ "id": "cs_live_a1B2c3D4", "status": "awaiting_payment", "paymentUrl": "https://checkout.stripe.com/c/pay/cs_live_a1B2c3D4", "paymentIntentId": "pi_3Q7abcDEF", "amountTotalCents": 4458, "currency": "usd", "buyerId": "9f1c4e2a-3b7d-4c1e-8f2a-5d6b7c8e9f01", "product": { "id": 105, "name": "Physical Damage - Temporary Substitute" }, "units": 3, "coverageStart": "2026-12-01T06:00:00.000Z", "coverageEnd": "2026-12-04T05:59:59.999Z"}List the products a buyer can purchase GET
List the insurance products a buyer can buy from you. Each product lists the questions a quote must answer. When you're ready to quote one, get it with `GET /buyers/{buyerId}/products/{productId}`: that response includes a ready-to-fill quote request.
Get a purchase's certificates GET
Get the certificate of insurance PDFs for a purchase. There's one certificate for each day or trip covered, in order. If a certificate was corrected after purchase, its `url` points to the corrected PDF. Certificates are issued a few seconds after payment. If a purchase that was just paid has none yet, try again for up to two minutes.