Create a hosted session
Specify which actions the session allows. A session scoped todomain_search and domain_purchase lets the user search for and buy a domain, but not manage DNS or renewals.
external_user_id and external_account_id let you correlate the session, and anything purchased through it, back to your own user records. They’re optional but recommended.
Redirect or embed
Use whichever fits your product:- Redirect: sends the user’s browser to
hosted_urlfor a full-page checkout experience. - Embed: loads
embed_urlin an<iframe>to keep the user inside your own product.
Session expiry
Sessions expire afterexpires_in_minutes (5–1440 minutes, default 60). Create a new session each time a user starts a domain search or purchase flow, don’t reuse a session across visits, since an expired session shows the user an error instead of the checkout flow.
Available actions
Combine actions based on what you want the user to be able to do in that session, for example, a renewal reminder email might link to a session scoped to
["renew"] only.
Next steps
Hosted Sessions API reference
Full request and response schema for hosted sessions.