Skip to main content
POST
Cancel a line at its next anniversary
  • Credential: an API key. See Cancel at the anniversary.
  • Account: wholesale partners only: a line whose owner is not a wholesale partner returns 409 line_not_wholesale_metered. A direct account ends a line with terminate, or by canceling its per-line subscription in the dashboard.
  • Line-scoped keys: a line-scoped key gets 403 forbidden unless the line is in its list.
  • Test keys: a cancellation sent with an isnap_test_ account key schedules the end of the real line: see Test keys.
  • Idempotency-Key: not honored. Canceling a line that already has a cancel_at returns the same cancel_at, so a retry is safe.
  • Events: none. When the line ends after cancel_at, the events of a termination are sent, with origin: scheduled_cancellation in line.terminated.

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
required

Id of a line: line_ followed by 25 letters or digits.

Pattern: ^line_[0-9A-Za-z]{25}$

Response

The line, unchanged except for cancel_at.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

A line. billing_tier, byod, shared, test_line and inbound_only tell the kinds of line apart: a rented line (two-way or inbound-only), a BYOD line, a shared line, a test 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.