v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB

Domains

Purchase Privacy

Adds or renews WHOIS privacy protection for a domain. This is used to ensure personal contact details remain hidden from public WHOIS lookups. If WHOIS privacy is already enabled, this will extend the protection. If it’s not yet active, this will both purchase and enable the service. This is a billable action unless covered by a bundled privacy plan.

post/core/v1/domains/{domainName}:purchasePrivacy

Path parameters

domainNamestring required

DomainName is the domain to purchase Whois Privacy for.

Headers

X-Idempotency-Keystring

Example:083910ef-04e4-4bd1-a0bf-3737fe005ca8

A unique string (e.g., a UUID v4) to make the request idempotent. This key ensures that if the request is retried, the operation will not be performed multiple times. Subsequent requests with the same key will return the original result.

Request body

purchasePricenumber double

PurchasePrice is the (prorated) amount you expect to pay.

yearsinteger

Years is the number of years you wish to purchase Whois Privacy for. Years defaults to 1 and cannot be more then the domain expiration date.

Response

A successful response.

orderinteger required

Order is an identifier for this purchase.

totalPaidnumber double required

TotalPaid is the total amount paid, including VAT.

Example response

{
  "domain": {
    "domainName": "example.com",
    "createDate": "2023-01-15T14:30:00Z",
    "expireDate": "2025-01-15T14:30:00Z",
    "autorenewEnabled": true,
    "locked": true,
    "locks": [
      "clientTransferProhibited",
      "clientHold"
    ],
    "transferLockExpiresAt": "2023-03-16T14:30:00Z",
    "privacyEnabled": true,
    "contacts": {
      "admin": {
        "firstName": "John",
        "lastName": "Doe",
        "companyName": "Example Inc.",
        "address1": "123 Main Street",
        "address2": "Suite 400",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "email": "john.doe@example.com",
        "phone": "+15551234567",
        "fax": "+15557654321",
        "isVerified": true,
        "verificationId": 12345
      },
      "billing": {
        "firstName": "John",
        "lastName": "Doe",
        "companyName": "Example Inc.",
        "address1": "123 Main Street",
        "address2": "Suite 400",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "email": "john.doe@example.com",
        "phone": "+15551234567",
        "fax": "+15557654321",
        "isVerified": true,
        "verificationId": 12345
      },
      "registrant": {
        "firstName": "John",
        "lastName": "Doe",
        "companyName": "Example Inc.",
        "address1": "123 Main Street",
        "address2": "Suite 400",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "email": "john.doe@example.com",
        "phone": "+15551234567",
        "fax": "+15557654321",
        "isVerified": true,
        "verificationId": 12345
      },
      "tech": {
        "firstName": "John",
        "lastName": "Doe",
        "companyName": "Example Inc.",
        "address1": "123 Main Street",
        "address2": "Suite 400",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "email": "john.doe@example.com",
        "phone": "+15551234567",
        "fax": "+15557654321",
        "isVerified": true,
        "verificationId": 12345
      }
    },
    "nameservers": [
      "ns1.example.com",
      "ns2.example.com"
    ],
    "renewalPrice": 12.99
  },
  "totalPaid": 4.99
}