Docs menu

API reference, Console billing

The account's places on the plan waiting lists

View as Markdown

GET/v1/console/waiting-listoperation id getWaitingList

The account's open waiting-list entries, at most one per plan: waiting with its position (1 is invited next), or invited with a seat held until invite_expires_at (subscribe with createSubscriptionCheckout before then). An entry leaves the list when the account holds its plan, or when its invitation expires.

Authentication. Console session cookie (__Host-dex_session), or an app session token (Authorization: Bearer dex_ses_...). With the cookie, state-changing routes also need the x-dex-csrf header.

Responses

200The account's entries, oldest first (an empty list when it is on no waiting list).

Headers: x-request-id

objectstringrequired
  • always "list"
dataarray of WaitingListEntryrequired
data[].objectstringrequired
  • always "waiting_list_entry"
data[].planPlanIdrequired
A subscription plan (docs/pricing-v2.md). New plans may appear within v1.
  • one of "base", "hot", "fierce"
data[].statusstringrequired
waiting: in the queue. invited: a seat is held for the account until invite_expires_at; subscribe with createSubscriptionCheckout before then.
  • one of "waiting", "invited"
data[].positioninteger | nullrequired
Place among the accounts waiting for this plan (1 is invited next); null once invited.
  • at least 1
data[].createdstringrequired
When the account joined the waiting list.
  • format date-time
data[].invite_expires_atstring | nullrequired
With invited, until when the seat is held (72 hours after the invitation); null while waiting.
  • format date-time
401Missing, unknown, revoked or expired credentials.

Headers: x-request-id, x-client-request-id

Error envelope. See Errors for every type and code.

403The credentials are valid but not allowed to do this (missing scope, suspended account or failed CSRF check).

Headers: x-request-id, x-client-request-id

Error envelope. See Errors for every type and code.

500An unexpected error. Any charge was refunded. Retry with the same idempotency key.

Headers: x-request-id, x-client-request-id

Error envelope. See Errors for every type and code.

503maintenance: the console's database, sign-in or payments are unavailable for a moment (for createGoogleSession also: Google sign-in is not configured, or Google's signing keys cannot be fetched). Retry after retry-after. Nothing was changed.

Headers: x-request-id, retry-after

Error envelope. See Errors for every type and code.

Examples

Illustrative values. Examples show the shape of requests and responses; the numbers in them are not measured results.

Response: On the Hot waiting list, twelfth in line

{
  "object": "list",
  "data": [
    {
      "object": "waiting_list_entry",
      "plan": "hot",
      "status": "waiting",
      "position": 12,
      "created": "2026-09-28T09:41:07Z",
      "invite_expires_at": null
    }
  ]
}