v13

OpenAPI 3.0.32026-07-31359869.4 MB

domains-registrar

Buy a domain

post/v1/registrar/domains/{domain}/buy

Path parameters

domainstring required

A valid domain name

Query parameters

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

Request body

autoRenewboolean required

Whether the domain should be auto-renewed before it expires. This can be configured later through the Vercel Dashboard or the Update auto-renew for a domain endpoint.

yearsnumber required

The number of years to purchase the domain for.

expectedPricenumber required

languageCodestring

The language code for the domain. For punycode domains, this must be provided. The list of supported language codes for a TLD can be retrieved from the Get TLD endpoint.

Response

Success

orderIdstring required

A valid order ID

_linksobject required