Brivio API reference
Domains

One domain order with its effective status (scope: domains:read)

GET
/domains/orders/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key as Bearer token

Path Parameters

id*string

Domain order id

Formatuuid

Response Body

OK

application/json
  1. response
data*

A domain registration or transfer REQUEST. Nothing is bought until an org admin confirms it in Brivio with a step-up. Never carries the auth code.

error*null
curl -X GET "https://example.com/domains/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "domain_order",    "kind": "register",    "domain": "string",    "period": 0,    "status": "pending",    "quoted_price_cents": 0,    "currency": "string",    "requested_via": "api",    "expires_at": "2019-08-24T14:15:22Z",    "decided_at": "2019-08-24T14:15:22Z",    "result_domain_id": "cb832555-4df7-4a68-be4b-593b20133ca4",    "last_error": "string",    "created_at": "2019-08-24T14:15:22Z",    "confirm_url": "http://example.com"  },  "error": null}

Order a domain registration or transfer. This is NOT a purchase: the order stays pending until an org admin confirms it in Brivio with a second factor (confirm_url) and expires after 72 h. Returns the quoted price, never the auth code. A taken domain or a second pending order for it is 409, a platform host 422, no registrar 503. Honours Idempotency-Key. (scope: domains:write) POST

Previous Page

Retail price of transferring a domain to Brivio (its TLD). 503 when no registrar is configured (scope: domains:read) GET

Next Page