Skip to main content
POST
domains.registration.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
domain
string
required

Bare domain name, such as example.com.

Required string length: 1 - 253
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
price
object
required

Exact retail price from the latest quote.

registrant
object
required

Builder who owns the domain.

years
integer
default:1

Term in years, 1 to 10.

Required range: 1 <= x <= 10
admin
object

Administrative contact; defaults to registrant.

tech
object

Technical contact; defaults to registrant.

billing
object

Billing contact; defaults to registrant.

privacy
boolean
default:true

Use free privacy where supported.

tldAttributes
object

Registry-required registration attributes.

Response

The result

domain
string
required

Bare domain name, such as example.com.

Required string length: 1 - 253
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
state
enum<string>
required

Current registration state.

Available options:
active,
suspended,
expired_renewable,
removed,
transferred_out
expiresAt
string<date-time>
required

Paid expiry date.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
verification
object
required
price
object
required

Confirmed retail price.

ref
string

Reference to what this call created. Pass it as ref to domains.registration.get.