Sign in

Create domain checkout link

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Creates a one-time checkout link for buying a domain through Base44.

Not every workspace can buy domains through the API. For one that can't, the call is rejected and the domain has to be bought in the Base44 editor.

Pass domain to open checkout on that domain, and check it first with Check domain availability. Leave it out to open checkout on a domain search.

The person who opens the link pays at checkout, and nothing is bought until they finish. The domain is then attached to the app once it's registered, and appears in List custom domains.

Each call returns a new link and buys nothing, so retrying is safe, including after a timeout. The call fails while the checkout provider is unavailable.

Creating links is limited to 6 requests a minute and 20 an hour per caller. Some workspaces have a different limit.

post/api/apps/{app_id}/custom-domains/purchase-url

Path parameters

app_idstring required

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

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

Request body

domainstring nullable

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

offer_business_emailboolean

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

Example request

{
  "domain": "nordwind-furniture.com"
}

Response

Successful Response

urlstring 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 response

{
  "url": "https://checkout.example.com/session/7c1e9f2a4b8d4e6f9a3c5b7d1e2f4a6c"
}

Changes

Changed in 1 of the 14 revisions of this API.1