---
title: "Stop a customer's mobile data"
method: POST
path: "/v1/user-plans/{userId}/data-restriction"
tags: ["User Plans"]
---

# Stop a customer's mobile data

`POST /v1/user-plans/{userId}/data-restriction`

## Request

- Base URL: `https://api.telgea.com`
- URL: `https://api.telgea.com/v1/user-plans/{userId}/data-restriction`
- Auth: API key in header `x-api-key`

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.

## Path parameters

- `userId` string, uuid, required: UUID of the user whose plan this is.

## Headers

- `idempotency-key` string: 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.

## Request body

- DataRestrictionBody
  - `reason` string: Free text kept with the change and shown to our support staff.

## Response `200`

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

- DataRestrictionResponse
  - `numbers` string[], required: The phone numbers the request actually reached at the network.
  - `effectiveAt` string, required: When the change took effect at the network.

## Other responses

- `400`: Request failed schema validation, or was refused by a business rule
- `401`: Missing or invalid API key in the X-API-Key header
- `403`: Insufficient permissions for this action
- `404`: User not found. The specified user ID does not belong to a user in your organization.
- `409`: Already in the state you asked for, so nothing was changed.
- `422`: Nothing was changed: the subscriber belongs to no data pool, so there is no data to stop, or their market does not offer stopping data on its own.
- `429`: The API key has used its request quota for the current window. `Retry-After` says how many seconds until it resets.
- `500`: Internal server error. Contact support if this persists.

---

[API](https://skmtc.dev/telgea/apis/telgea-api.md) - [All operations](https://skmtc.dev/telgea/apis/telgea-api/llms.txt) - [OpenAPI document](https://skmtc.dev/telgea/apis/telgea-api/revisions/4e8f8c04fe9e?raw)