Skip to main content
POST
Cancel a Line
This is a cancellation request, shaped like cancelling a subscription — not a delete. The line keeps working right up to the end of the period you have already paid for. Nothing is removed, and the conversations on it stay readable afterwards.

Endpoint

  • Method: POST
  • Path: /api/lines/cancel
  • Auth: Authorization: Bearer tuco_xxxxxxxxxxxxx (workspace key)

Body

Example request

Success response (200)

The line keeps sending

This is the part worth internalising: a cancelled line is still a working line until cancelEffectiveAt. It sends, it receives, it appears in your campaigns. You paid for the period; you keep it. What changes immediately is only what the line is called. GET /api/lines reports: Each line also carries cancelEffectiveAt, or null if it is not cancelling.

When it stops

The setup fee is not refunded. It paid for provisioning that has already happened — a number acquired, a device configured. setupFeeRefunded: false is returned on every response rather than left unsaid.

Calling it twice is safe

A second request returns the same date with newlyRequested: false. The date is set once and never recomputed, so a repeated call can never accidentally move your cancellation into the following month.

Only an active line

A line that is still being provisioned has never sent anything, so there is no paid period to run out. Cancel that order instead — the error says so:

Error responses

If your workspace belongs to an agency

Lines in an agency-managed workspace are paid for by the agency, so only the agency can end one. You can still read their status and order new ones — ask your agency admin to cancel.