Build a checkout link
POST/api/v1/public_checkout/link
Builds the URL a landing page publishes, already carrying the plan, the billing cycle, the extra inboxes and the coupon — so the page does not have to write the query string by hand.
No API key: the price table is public, and so is this.
The plan is named by slug, never by id. A plan's numeric id differs between
installations and environments, so a landing page holding a fixed id points at the
wrong plan the moment it leaves the environment it was written in.
Customer data never goes in the URL. Anything sent under customer is stored
server-side for 24 hours and the link carries only an opaque prefill token. A
name, e-mail, phone and tax id in a query string would end up in the browser
history, the server access log and the Referer header sent to Stripe and hCaptcha.
The checkout swaps the token for the data and drops it from the address bar.
Only what differs from the checkout's own defaults reaches the URL: a link with
cycle=month and inboxes=0 says exactly what a bare link says.
Request
Responses
- 200
- 422
The link is ready to publish
No published plan with that slug, a cycle that cannot be charged, or a negative number of extra inboxes