Change Device Service Plan

PUT /devices/actions/plan

Changes the service plan for one or more devices.

Contents

See also:
Retrieve a List of Service Plans
Retrieve Information about Devices
Change Device Identifier

Uses and Requirements

• You can change the service plan for an active device up to four times per month.
• You cannot change the service plan for a device while its service is suspended.
• Use separate requests to change 3G and 4G devices unless your account is set up to allow both types of devices in the same service plan.

ThingSpace sends an asynchronous CarrierService callback message for each device in the request when the service plan has been changed, or if there was a problem and the change could not be completed.

The M2M Platform sends another asynchronous NiddService callback message for each NB-IoT device in the request, if the change is to add an NIDD price plan, and when NIDD Config for the device has been enabled.

Request Components

HTTP Request

PUT https://thingspace.verizon.com/api/m2m/v1/devices/actions/plan

Resource Path and Query Parameters

None.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Request Body

The request body identifies the devices that you want to change. You can either list individual devices, or work with all devices in an account or device group, and optionally filter by service plan or custom field values.

* You can either specify up to 10,000 individual devices with the devices parameter, or you can use any combination of groupName, currentServicePlan, and customFields to run the request on all devices that match all criteria.

Example Request Body

Change the service plan for a single device

{ "devices": [
 { "deviceIds": [
   { "id": "A100003685E561",
     "kind": "meid"
    }
   ]
   }
  ],
"servicePlan": "new_service_plan_code",
"carrierIpPoolName": "carrier_Ip_Pool_Name"
}

Change the service plan for two devices

{ "devices": [
  { "deviceIds": [
   { "id": "89148000000800259784",
     "kind": "iccid"
   } ]
  },
  { "deviceIds": [
   { "id": "89148000001134189816",
     "kind": "iccid"
   } ]
 } ],
   "servicePlan": "Tablet5GB",
   "carrierIpPoolName": "carrier_Ip_Pool_Name",
   "accountName": "0242078637-00001"
}

Move all devices with one service plan to another service plan

{
  "currentServicePlan": "existing_service_plan_code", 
  "servicePlan": "new_service_plan_code"
}

Success Responses

Status 200

Example Success Response

{ "requestId": "c8de7c1d-59b9-4cf3-b969-db76cb2ce509" }

CarrierService Callback Parameters

Example CarrierService Success Callback Response

{
   "username":"",
   "password":"",
   "requestId":"c8de7c1d-59b9-4cf3-b969-db76cb2ce509",
   "deviceIds":[
     { "id":"8586928930",
       "kind":"mdn"
     } ],
   "deviceResponse":
     { "changeServicePlanResponse":
       { "effectiveDate":"5/31/2018 12:00:00 AM" }
     }
}

niddService Callback Parameters

Example niddConfig Success Callback Response

{
  "username" : "user",
  "password" : "pwd",
  "requestId" : "3c5eef41-011c-4c20-8780-f4031180141b",
  "niddResponse" : {
    "niddConfigResponse" : {
      "accountName" : "9992330389-00001",
      "deviceIds" : [ {
        "id" : "99962019000000000000000000000002",
        "kind" : "EID"
      }, {
        "id" : "9996201900000000000345",
        "kind" : "IMEI"
      } ]
    }
  },
  "status" : "ConfigCreated",
  "callbackCount" : 1,
  "maxCallbackThreshold" : 4
}

Example niddConfig Failure Callback Response

{
  "username" : "user",
  "password" : "pwd",
  "requestId" : "4c5eef41-011c-2c20-8780-f4031180141b",
  "niddResponse" : {
    "niddConfigResponse" : {
      "accountName" : "9992330389-00001",
      "reason" : "Not CatM or NBIoT Device",
      "deviceIds" : [ {
        "id" : "99962019000000000000000000000002",
        "kind" : "EID"
      }, {
        "id" : "9996201900000000000345",
        "kind" : "IMEI"
      } ]
    }
  },
  "status" : "ConfigFailed",
  "callbackCount" : 1,
  "maxCallbackThreshold" : 4
}

Failure Responses

Status 400

All error messages are returned in this format:

{
      "errorCode": "error code string",
      "errorMessage": "error message string"
    }