User Plans

Stop a customer's mobile data

Stops mobile data for one of your customers — for someone who has used up what they paid for. Calls and texts keep working; use the suspension endpoint to stop the whole line.

The call returns once the change has taken effect at the network, so a 200 means the data is genuinely off. Nothing here is queued for later.

Stopping data that is already stopped returns 409 and changes nothing. Our own automated processes never undo a stop you made — only DELETE on this path does.

Not every market offers stopping data on its own. Where it does not, this returns 422 and nothing changes — the Markets page in the documentation lists which is which.

post/v1/user-plans/{userId}/data-restriction

Request

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

Path parameters

userIdstring uuid required

UUID of the user whose plan this is.

Example:9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01

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

reasonstring

Free text kept with the change and shown to our support staff.

Example request

{
  "reason": "Customer exceeded their agreed data allowance."
}

Response

Data stopped. Lists the numbers the stop reached and when it took effect.

numbersstring[] required

The phone numbers the request actually reached at the network.

effectiveAtstring required

When the change took effect at the network.

Example response

{
  "numbers": [
    "+4520123456"
  ],
  "effectiveAt": "2026-09-14T09:30:00.000Z"
}

Changes

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