SIMs (Devices)

Change SIM data plan

Change the data plan for the given device. Non-pending paused profiles (PAUSED-USER, PAUSED-SYS) can change plans when the new plan uses the same CSP (no coverage change). Pending paused profiles remain rejected. Warning: Changing data plans will remove any set data limits.

post/devices/{deviceId}/changeplan

Request

Path parameters

deviceIdinteger required

ID of the device

Query parameters

previewboolean

If true, simulate the operation without making changes

Request body

planidinteger required

ID of the data plan to assign

zonestring required

Geographic zone for the plan

orgidinteger required

Organization ID of the devices to change plans for

overage_limitinteger

Additional bytes of data allowed above the plan's included data; SIM pauses when usage exceeds plan included data plus this value (-1 for unlimited, 0 for plan included data only)

useacctbalanceboolean

Apply account balance credit to this order

Example request

{
  "planid": 4,
  "zone": "global",
  "orgid": 45
}

Response

OK

successboolean

Indicates whether the request was successful.

Example response

{
  "success": true
}

Changes

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