Skip to main content
POST
Cancel 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.
  • Idempotency-Key: not honored. A second cancel returns 400 pre_order_already_confirmed.
  • Events: sends pre_order.cancelled, which only a subscription without a line filter receives: see Events.
  • Statuses: a pre-order in draft or awaiting_payment can be canceled. For a pre-order in awaiting_payment, the payment of the first month is canceled first: the stripe_client_secret of the confirmation can no longer be used. Once its build has started, a pre-order cannot be canceled through the API. See Canceling.
  • 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, in status cancelled.

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.