POST
/
v5
/
domains
/
buy
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.domains.buyDomain({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "example.com",
      expectedPrice: 10,
      renew: true,
      country: "US",
      orgName: "Acme Inc.",
      firstName: "Jane",
      lastName: "Doe",
      address1: "340 S Lemon Ave Suite 4133",
      city: "San Francisco",
      state: "CA",
      postalCode: "91789",
      phone: "+1.4158551452",
      email: "jane.doe@someplace.com",
    },
  });

  // Handle the result
  console.log(result);
}

run();
{
  "domain": {
    "uid": "<string>",
    "ns": [
      "<string>"
    ],
    "verified": true,
    "created": 123,
    "pending": true
  }
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json
​
name
string
required

The domain name to purchase.

Example:

"example.com"

​
country
string
required

The country of the domain registrant

Example:

"US"

​
firstName
string
required

The first name of the domain registrant

Example:

"Jane"

​
lastName
string
required

The last name of the domain registrant

Example:

"Doe"

​
address1
string
required

The street address of the domain registrant

Example:

"340 S Lemon Ave Suite 4133"

​
city
string
required

The city of the domain registrant

Example:

"San Francisco"

​
state
string
required

The state of the domain registrant

Example:

"CA"

​
postalCode
string
required

The postal code of the domain registrant

Example:

"91789"

​
phone
string
required

The phone number of the domain registrant

Example:

"+1.4158551452"

​
email
string
required

The email of the domain registrant

Example:

"jane.doe@someplace.com"

​
expectedPrice
number

The price you expect to be charged for the purchase.

Example:

10

​
renew
boolean

Indicates whether the domain should be automatically renewed.

Example:

true

​
orgName
string

The company name of the domain registrant

Example:

"Acme Inc."

Response

201
application/json
​
domain
object
required