Skip to main content
GET
List pre-orders
  • Credential: an API key.
  • Line-scoped keys: the list of lines of a line-scoped key is not applied.
  • Events: none.
  • Pages: the response has items, has_more and next_cursor. A cursor that cannot be read restarts the list from the first page with 200, and the cursor does not carry the status filter: see Listing and Cursors.
  • Secret: stripe_client_secret is null on every item: only the confirm response returns it.
  • Payment: the list does not check payments. A pre-order whose first month was just paid can be listed as awaiting_payment: read it with GET /v1/pre-orders/{id}.
  • Caching: the response carries Cache-Control: no-store, whatever its status.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Query Parameters

status
enum<string>

Keep the pre-orders in this status.

Available options:
draft,
awaiting_payment,
provisioning,
fulfilled,
cancelled
cursor
string

The next_cursor of the previous page. Omit it for the first page. An unreadable cursor restarts from the first page, without an error.

limit
integer
default:25

Number of pre-orders per page, from 1 to 100. Default: 25.

Required range: 1 <= x <= 100

Response

One page of pre-orders.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

One page of pre-orders.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.