Operator

Platform operators: mark paid, mark registered, refund (a Stripe payment is refunded first), cancel, retry, or reveal a transfer code

post/operator/domain-orders/{orderId}/action

Request

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

Path parameters

orderIdstring uuid required

Request body

action'mark_paid' | 'mark_registered' | 'refund' | 'cancel' | 'retry' | 'reveal_auth_code' required
reasonstring required

why (shown in the operator audit log)

expiresAtstring

mark_registered: when the registration expires (default: now + the years ordered)

Response

Done

idstring uuid required
status'awaiting_payment' | 'paid' | 'registering' | 'registered' | 'failed' | 'refunded' | 'cancelled' required
replayboolean required
authCodestring nullable required

reveal_auth_code only: the transfer code (shown once, audited)

refund'stripe' | 'manual' | 'none' | 'null' nullable required

refund: how the money goes back (manual: pay it back yourself)

Changes

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