Domains

Cancel an order that is not paid yet (its payment link stops working)

post/domain-registrations/orders/{orderId}/cancel

Request

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

Path parameters

orderIdstring uuid required

Response

Cancelled

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.