<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 link to the checkout page for business email on one of your workspace's custom domains.

Pass a domain that's connected to an app in this workspace and verified. Find your domains with List custom domains. The check uses the domain's last recorded status, so a domain you just connected may need to finish verifying first. The person who opens the link picks a plan and pays, and nothing is bought until they finish checkout. The new business email then appears in Get business email status as PENDING_SETUP.

Only the workspace owner can create the link. A workspace whose plan is paid through the App Store can't buy business email. A read-only token is refused, and workspace API keys aren't accepted.

<Note>The link signs whoever opens it in to your workspace's billing account, and it works once. Don't share it, and create a new link each time.</Note>

Each call returns a new link and buys nothing, so retrying is safe. Limited to 6 requests a minute per caller. Some workspaces have a different limit.

{
  "domain": "acme.com"
}

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