Skip to main content
POST
Confirm 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.
  • Test keys: a confirmation sent with an isnap_test_ account key is a real order: see Test keys.
  • Idempotency-Key: not honored. A direct account can repeat the confirmation: while the pre-order is awaiting_payment, a repeat returns the same stripe_client_secret and starts no second billing, and after the payment it returns the pre-order in provisioning. A wholesale partner’s repeat returns 400 pre_order_not_draft. See Confirm and payment.
  • Events: none. The response is the only signal. pre_order.fulfilled is sent later, when iSnap hands the line over, and pre_order.cancelled when the first month is not paid within 23 hours: see Events.
  • Response: a wholesale partner receives the pre-order in provisioning, with stripe_client_secret: null. A direct account receives it in awaiting_payment, with no line yet: the build starts once the first month is paid. When that first month is already paid, the response is in provisioning.
  • Secret: stripe_client_secret is the secret of the first monthly payment, returned only by this response, while the pre-order is awaiting_payment. No operation that an API key can call pays it: pay the first month in the iSnap dashboard, by card, within 23 hours of the confirmation. See Accounts. The response carries Cache-Control: no-store, whatever its status.
  • No way back: once its build has started, a pre-order cannot be canceled through the API. See Canceling.

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: in status awaiting_payment with its stripe_client_secret for a direct account whose first month is due, in status provisioning otherwise.

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.