• page: Integer | page number (default: 1)
• per_page: Integer | records per page (default: 50, max: 100)

• orders: Array
  • id: String | uuid
  • status: String
  • created_at: DateTime
  • updated_at: DateTime
  • location: String | location short_name, or null for orders with no location (e.g. domain-registration orders)
  • account: Object
    • id: String
    • name: String

• order: Object
  • id: String | uuid
  • status: String
  • created_at: DateTime
  • updated_at: DateTime
  • location: String | location short_name, or null for orders with no location (e.g. domain-registration orders)
• tasks: Array
  • id: Integer
  • status: String
• site: Object | present when the order provisioned a site
  • id: String
  • name: String
  • domain: String
  • variant: String
  • location: String
  • ssh_data: Object
    • ipaddr: String
    • username: String
    • password: String
    • port: Integer
• subscription: Object | present when the order has a backing subscription
  • id: String
  • status: String
  • bucket_type: String
  • bucket_year: Integer
  • bucket_month: Integer
  • stripe_id: String
• payment: Object
  • status: String | see payment status enum below
  • method_type: String | card, sepa_debit, or null
  • hosted_invoice_url: String | null
  • amount_charged_cents: Integer
  • credit_applied_cents: Integer
• account: Object | See accounts#show
• user: Object | See users#show

• site: Object (required)
  • name: String (required)
  • variant: String (required) | vanilla, extendify
  • location: String (required) | Location short_name (e.g. "pdx")
  • plan: String (required) | Product short_name (e.g. "basic")
  • term: String (required) | monthly or annual
• callback: Object | optional outbound notification POSTed when the order's async task completes — see Callbacks
  • authorization: String | full Authorization header value. Example: Bearer 12345
  • url: String | fully qualified URL

• status: String | "accepted"
• cart: Object
  • token: String
  • status: String | active, processing, checked_out
  • rollup_status: String | pending, processing, completed, ...
  • poll_url: String | /api/carts/<token>
• payment: Object
  • status: String | processing, succeeded, awaiting_authentication
  • method_type: String | card, sepa_debit, or null
  • hosted_invoice_url: String | null
• orders: Array
  • id: String | uuid
  • status: String | pending
  • poll_url: String | /api/orders/<id>

• no_default_payment_method | billing account not ready to charge
• unknown variant / location / term / plan
• variant not available (over capacity)
• missing pricing information
• "Account unable to create orders."

• domain: Object (required)
  • name: String (required) | fully-qualified, e.g. example.com
  • action: String (optional) | register (default) or transfer
  • authcode: String | required for transfers when the TLD requires an authcode
  • contact: Object | inline registrant; required unless contact_source is given
    • first_name: String (required)
    • last_name: String (required)
    • organization: String (optional)
    • street_address: String (required)
    • post_code: String (required)
    • city: String (required)
    • state: String (optional/required per TLD)
    • country: String (required) | 2-letter ISO code
    • email: String (required)
    • phone: String (required) | E.164, e.g. +1.5555555555
    • extra_properties: Object | TLD-specific registry fields (e.g. .it entityType)
  • contact_source: Object | reuse an owned registration's contacts instead of contact
    • registration_id: Integer (required) | an owned DomainRegistration that has an owner contact
  • role_contacts: Object (optional) | admin / billing / tech; each:
    • source: String | same_as_owner (default), existing, or new
    • source_registration_id: Integer | when source is existing
    • first_name, last_name, ... | the same contact fields as above, when source is new
• callback: Object (optional) | same callback contract as POST /api/orders — see Callbacks
  • authorization: String | full Authorization header value. Example: Bearer 12345
  • url: String | fully qualified URL

Identical envelope to POST /api/orders:

• status: String | "accepted"
• cart: Object | { token, status, rollup_status, poll_url }
• payment: Object | { status, method_type, hosted_invoice_url }
• orders: Array | [{ id, status, poll_url }] (empty during the async window)

Authorization / gating:

• 401 user_required | system Account-bearer key (no user)
• 503 feature_disabled | domain registration not enabled
• 403 trial_account | trial accounts cannot order domains

Validation (400, no charge / no order created):

• invalid_action | action not register or transfer
• invalid_domain | name failed normalization/validation
• unsupported_tld | no configured TLD for the name
• pricing_unavailable | no orderable price for the account's billing plan
• authcode_required | transfer of a TLD that requires an authcode, none supplied
• incomplete_contact | inline contact missing required fields
• invalid_contact | inline contact has a bad value (e.g. country not 2 letters)
• invalid_contact_source | contact_source.registration_id not found or has no owner contact
• no_default_payment_method | billing account not ready to charge

Processing (422):

• domain_unavailable | registry says the name is not registerable (register only)
• domain_add_failed | cart rejected the domain (e.g. already owned)
• domain_contact_invalid | registrant contact rejected (body carries violations)
• domain_contact_needs_augmentation | TLD needs extra contact fields (body carries needs_augmentation)
• cart_pay_failed | payment could not be initiated (any contacts created for this request are torn down)

• status: String | "accepted"
• cart: Object
  • token: String
  • status: String
  • rollup_status: String
  • poll_url: String
• payment: Object
  • status: String
  • method_type: String | card, sepa_debit, or null
  • hosted_invoice_url: String | null
• orders: Array
  • id: String | uuid
  • status: String
  • poll_url: String