Skip to content

List Plans

GET
/mailboxes/schedule-buy/plans

The org’s plans, newest first, with live progress on each.

mailboxes_provisioned and landing_pages_hosted are best-effort decoration: a failure computing them reports zero rather than failing the list, so do not read a zero as “nothing has been provisioned”.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

A named collection ({"plans": [...]}) keeps its own key AND gains items, so a caller can page every list surface the same way without memorising which key each route chose.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string