Lexicon Garden

at.marque.partner.getOrder

Poll an order created by createCheckout. Call it proxied through the user's PDS (atproto-proxy: did:web:marque.at#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.

Repository @marque.at did:plc:nckosudltxrtrjkt4zz4jy5y namespace authority
Details · query
Kindquery
Authoritypartner.marque.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

orderId

requiredstring

The order id returned by createCheckout.

Output

application/json

checkoutUrl

string · uri

Hosted payment URL. Present while status is awaitingPayment so a partner can resume an interrupted checkout.

error

string

Failure reason when status is failed.

items

requiredarray

One entry per domain in the order, in the order submitted to createCheckout.

itemsref
Reference

orderId

requiredstring

Echoes the requested order id.

status

requiredstring

Overall order status. awaitingPayment: the user has not completed Stripe checkout. paid: payment captured, registration queued. provisioning: registering with the registry. provisioned: all domains registered (individual items may still be failed). failed: the order could not be provisioned.

  • knownValues: awaitingPayment | paid | provisioning | provisioned | failed

Errors

NotFound

No order with that id is owned by the authenticated user.

#item

object

Properties

domain

requiredstring

The fully qualified domain name.

  • maxLength: 253

expiresAt

string · datetime

When the registration expires. Present once the item is active. Write this into the at.marque.domain record.

nameServers

array

Authoritative nameservers assigned to the domain. Present once the item is active.

itemsstring
  • maxLength: 253

registeredAt

string · datetime

When the domain was registered upstream. Present once the item is active.

status

requiredstring

Per-domain provisioning status. pending: not yet registered. active: registered successfully. failed: registration failed for this domain.

  • knownValues: pending | active | failed

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.