Skip to main content
POST
Create domain checkout link

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app you're finding a domain for.

Body

application/json
domain
string | null

Domain to open checkout on, such as example.com. Leave it out to open checkout on a domain search.

Example:

"nordwind-furniture.com"

offer_business_email
boolean
default:false

Whether checkout also offers a business email address on the domain after the purchase (true) or not (false).

Example:

false

Response

Successful Response

A checkout link for buying a domain.

url
string
required

Checkout link to open in the browser of the person who'll pay. Treat it as opaque. It works once, so create a new one for each checkout.

Example:

"https://checkout.example.com/session/7c1e9f2a4b8d4e6f9a3c5b7d1e2f4a6c"