commerce
commerce

Create Checkout

Start a Stripe Checkout Session — for a shelf product, or for a shaped list.

Returns the hosted Checkout URL — the frontend redirects the buyer. A commerce.order row is created with status='pending' immediately; the webhook flips it to 'paid' then 'delivered' as fulfillment completes. A list order (ADR-045) also freezes its Run Manifest here, before payment.

Rate limited per IP to prevent orphan-session abuse.

post/api/v1/commerce/checkout

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/commerce/checkout
  • Auth: API key in header X-API-Key

Request body

product_idstring nullable
success_urlstring nullable
cancel_urlstring nullable
customer_emailstring nullable
list_idstring nullable
statesstring[] nullable
filtersobject[] nullable
include_heldboolean
include_existingboolean
lanestring nullable
capobject nullable
channelstring nullable
contactstring nullable
deliverystring
crm_connection_idstring nullable
connector_crm_namestring nullable
price_rule_versioninteger nullable
expected_total_centsinteger nullable
offer_codestring nullable

Response

Successful Response

session_idstring required
checkout_urlstring required
order_idstring required
quoteobject nullable
saved_listobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.