Skip to main content
GET
Get a pre-order
  • Credential: an API key of the account that owns the pre-order.
  • Line-scoped keys: the list of lines of a line-scoped key is not applied.
  • Events: none.
  • Line: the pre-order carries no line id. pre_order.fulfilled gives it: see How a pre-order works.
  • Secret: stripe_client_secret is null here: only the confirm response returns it.
  • Payment: reading a pre-order in awaiting_payment checks the payment of its first month. When that payment has succeeded, the build starts and the response is in provisioning. When the check cannot be made, the response is still 200, in awaiting_payment. See Confirm and payment.
  • Statuses: status and device_status are described in Statuses.
  • 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.

Path Parameters

id
string<uuid>
required

Id of the pre-order: the UUID returned in id by POST /v1/pre-orders.

Example:

"7f3b9c1e-2a4d-4f6b-8e0a-5c1d2e3f4a5b"

Response

The pre-order.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

A pre-order: an order for one rented iMessage line.

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.