at.marque.partner.getOrder

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "item": {
      "properties": {
        "domain": {
          "maxLength": 253,
          "type": "string"
        },
        "expiresAt": {
          "format": "datetime",
          "type": "string"
        },
        "nameServers": {
          "items": {
            "maxLength": 253,
            "type": "string"
          },
          "type": "array"
        },
        "registeredAt": {
          "format": "datetime",
          "type": "string"
        },
        "status": {
          "description": "Per-domain provisioning status.",
          "knownValues": [
            "pending",
            "active",
            "failed"
          ],
          "type": "string"
        }
      },
      "required": [
        "domain",
        "status"
      ],
      "type": "object"
    },
    "main": {
      "description": "Poll an order created by createCheckout. Call it proxied through the user's PDS (atproto-proxy: did:web:marque.at:api#marque_registrar) with an at.marque.partnerApi-scoped token; only orders owned by the authenticated user (the JWT iss) are returned. Status flows awaitingPayment (user has not finished paying) -> paid -> provisioning -> provisioned (or failed). Poll every few seconds until provisioned or failed. Once provisioned, each item carries the registeredAt, expiresAt, and nameServers the partner needs to write the at.marque.domain and at.marque.dns records into the user's repository. Individual items can be failed even when the order is provisioned (a partial failure); check each item's status.",
      "errors": [
        {
          "description": "No order with that id is owned by the authenticated user.",
          "name": "NotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "error": {
              "description": "Failure reason when status is failed.",
              "type": "string"
            },
            "items": {
              "items": {
                "ref": "#item",
                "type": "ref"
              },
              "type": "array"
            },
            "orderId": {
              "type": "string"
            },
            "status": {
              "knownValues": [
                "awaitingPayment",
                "paid",
                "provisioning",
                "provisioned",
                "failed"
              ],
              "type": "string"
            }
          },
          "required": [
            "orderId",
            "status",
            "items"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "orderId": {
            "description": "The order id returned by createCheckout.",
            "type": "string"
          }
        },
        "required": [
          "orderId"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "description": "Get the status of a partner checkout order and the resulting domain details.",
  "id": "at.marque.partner.getOrder",
  "lexicon": 1
}