PurchaseDomainRequest
Request body for purchaseDomain: name + TLD + registrant contact + auto-renew/privacy/auto-connect options (P0-163).
import type { PurchaseDomainRequest } from 'flowstack-sdk'What purchaseDomain sends to POST /api/v1/registrar/purchase. Setting site_id makes the purchased domain auto-connect to that site after the payment webhook completes registration — the buy-and-wire path; omit it to just own the domain.
Signature
interface PurchaseDomainRequestReturns
| Field | Type | Description |
|---|---|---|
domain | string | Name WITHOUT the TLD, e.g. thezengarden (not thezengarden.com). |
tld | string | The TLD to register, e.g. com. |
registrant | RegistrantContact | WHOIS contact — registrar-validated formats (E.164 phone, ISO country code). |
auto_renew | boolean? | Renew automatically each year. |
whois_privacy | boolean? | Enable WHOIS privacy protection. |
site_id | string? | If set, the domain auto-connects to this site after payment — no separate connectDomain call needed. |
Note
domain is the bare name — passing thezengarden.com as domain with tld: "com" would attempt thezengarden.com.com.See also
purchaseDomain · RegistrantContact · DomainSearchResult · searchDomains
Source: src/types/index.ts (Domain Registrar, P0-163) · Also available in llms-full.txt and registry.json.