TEtelgea
Numbers

End a line

Ends the line on the date you name — the date the customer agreed to stop.

The line is suspended on that date and deactivated at the network 14 days later. The call returns as soon as the termination is scheduled, so a 202 means it is booked, not that the line is already down. Read it back on GET /v1/numbers/{numberId} as terminationScheduledAt.

Billing is not prorated. The customer keeps the period they already bought: the line stops on your date, and billing runs to activeUntil in the response. The plan does not renew afterwards.

Send deleteUser: true to delete the end-user along with the line. Otherwise the user remains, and DELETE /v1/users/{userId} succeeds once the line is suspended — you do not have to wait out the grace period.

The response lists every line the termination ends, which can be more than the one you named: a travel eSIM raised against this line's plan ends with it.

post/v1/numbers/{numberId}/termination

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Path parameters

numberIdstring uuid required

UUID of the line.

Example:8238c1b9-c2c0-4455-9b03-4bd787052709

Headers

idempotency-keystring

A value unique to this request, of 1 to 255 printable ASCII characters — a UUID is the usual choice. Retry with the same key within 24 hours and you get the original response back, even if it was a failure, and nothing is done twice. Send a new key whenever you change the request. Keys are private to your API key and organisation.

Example:0b7e4f1c-6a2d-4c9e-8f35-d1a7b2c93e60

Request body

terminationDatestring date required

The date the customer agreed to stop, as YYYY-MM-DD. Today is allowed; a past date is rejected.

deleteUserboolean

Delete the end-user once their line is gone. Defaults to false, in which case the user remains and can be deleted with DELETE /v1/users/{userId} once the line is suspended.

Example request

{
  "terminationDate": "2026-10-01"
}

Response

Termination scheduled. States the date, when billing stops, and the lines ending.

terminationDatestring required

The date the line stops, as accepted.

activeUntilstring nullable required

The end of the period already paid for. Billing runs to this date even when the line stops earlier; null when the plan carried no billing period.

numberIdsstring[] required

The lines this termination ends, by their number ids.

Example response

{
  "terminationDate": "2026-10-01",
  "activeUntil": "2026-12-31T00:00:00.000Z",
  "numberIds": [
    "9f1c6f3e-4f4a-4f2e-bb2a-2b9a1f0c8e11"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.