Retrieve a List of Service Plans:

GET /plans/{accountname}

Returns a list of all data service plans that are associated with a specified billing account. When you send a request to /devices/actions/activate to activate a line of service you must specify the code for one of the service plans associated with your account.

Contents

 

 

 

 

Request Components

HTTP Request

GET https://thingspace.verizon.com/api/m2m/v1/plans/{accountname}

Resource and Query Parameters

You must include the account name in the path.

Parameter Name Data Type Description
accountname
required		 string The name of the account for which a list of service plans will be returned. An account name is usually numeric, and must include any leading zeros.

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.

 

Parameter Name Data Type Description
Authorization
required		 string HTTP Authorization bearer token.
VZ-M2M-Token
required		 string A valid session token returned by POST /session/login.
Content-Type
required		 string Must be application/json.

Request Body

None.

Success Responses

Status 200 A successful request returns an array of servicePlan objects that contain these values:

Parameter Name Data Type Description
name string The name of the service plan.
code string The code of the service plan, which may not be the same as the name.
sizeKb int64 The size of the service plan in kilobytes.
carrierServicePlanCode string The code that is used by the carrier for the service plan.
extendedAttributes   Any extended attributes for the service plan, as Key and Value pairs.
 key string The key for an extended attribute.
 value string The value of an extended attribute.

Example Success Response

[
  {
    "name": "2MSHR5GB",
    "code": "M2MSHR5GB",
    "sizeKb": 0,
    "carrierServicePlanCode": "84638"
  },
  {
    "name": "TNTL200TALK",
    "code": "NTL200TALK",
    "sizeKb": 0,
    "carrierServicePlanCode": "74644"
  },
  {
    "name": "TNTL300SHR",
    "code": "NTL300SHR",
    "sizeKb": 0,
    "carrierServicePlanCode": "85135"
  },
  {
    "name": "2M250MB",
    "code": "M2M250MB",
    "sizeKb": 0,
    "carrierServicePlanCode": "84641"
  }
]

Failure Responses

Status 400

All error messages are returned in this format:

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

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!