Skip to main content
POST
Create Order

Authorizations

X-API-Key
string
header
required

Body

application/json

Request to create a domain order (without immediate payment)

domain
string
required
Required string length: 1 - 255
contact
RegistrantContactSchema · object
required

Contact information for domain registration

years
integer
default:1
Required range: 1 <= x <= 10
payment_method
enum<string>
default:card

Payment method: 'wire' or 'card'

Available options:
wire,
card
nameservers
string[] | null
privacy
boolean
default:true
auto_renew
boolean
default:true
registrar
string
default:namecheap

Registrar to use (currently only namecheap is supported)

setup_dns
boolean
default:false

Automatically setup DNS after purchase

dns_provider
string
default:cloudflare

DNS provider to use for setup

Response

Successful Response

Response for domain order with payment status

order_id
string<uuid>
required
domain_name
string
required
years
integer
required
price
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currency
string
required
status
enum<string>
required
Available options:
pending,
ready_to_process,
price_changed,
processing,
completed,
failed,
cancelled,
refunded
checkout_url
string | null
banking_details
BankDetails · object | null