Domains

Buy a name (idempotent per requestId). It is registered once paid and connected to projectId with DNS and HTTPS by itself

post/domain-registrations/orders

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/domain-registrations/orders
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Query parameters

orgIdstring

Organization id (required when you belong to several)

Request body

domainstring required

a domain name such as example.com (IDNs as punycode)

yearsinteger
projectIdstring uuid nullable

connect the name to this project once it is registered (DNS and HTTPS by themselves)

whoisPrivacyboolean

default: on where the TLD offers it

autoRenewboolean
expectedAmountinteger

the total the buyer saw for all the years; a different total answers conflict instead of charging it

expectedFirstYearinteger

the first-year price the buyer saw in a search (for several years the total is that plus the renewal price of each further year); a different price answers conflict instead of charging it

requestIdstring uuid required

idempotency key: the same request id never orders twice

Response

Ordered

idstring uuid required
domainstring required
tldstring required
kind'register' | 'renew' | 'transfer' required
yearsinteger required
status'awaiting_payment' | 'paid' | 'registering' | 'registered' | 'failed' | 'refunded' | 'cancelled' required
fulfillment'dynadot' | 'manual' required
amountinteger required

integer minor units of currency (cents, öre)

renewAmountinteger required

integer minor units of currency (cents, öre)

currencystring required

lowercase ISO 4217 code, e.g. usd or sek

whoisPrivacyboolean required
autoRenewboolean required
projectIdstring uuid nullable required
paymentUrlstring nullable required

where to pay while it awaits payment (a Stripe-hosted invoice), when there is one

waitingFor'payment' | 'registrar' | 'operator' | 'dns' | 'nothing' required

payment: pay it (without a payment link our team contacts you with the payment details); registrar: being registered now; operator: being registered by our team, usually within 24 h; dns: registered, its DNS and HTTPS are being connected; nothing: done or ended

statusDetailstring nullable required
paidAtstring nullable required

ISO-8601 timestamp

registeredAtstring nullable required

ISO-8601 timestamp

expiresAtstring nullable required

ISO-8601 timestamp

connectedAtstring nullable required

ISO-8601 timestamp

createdAtstring required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.