Device

Devices are the phones or smartwatches that will be tied to a user’s plan.

Name
object
Type
string
Description
Type of object is always device.
Allowed values: device
Name
id
Type
string
Description
Unique identifier for the device.
Example: "dev_0SNlurA049MEWV55CrA9qMvI2FVJ"
Name
metadata
Type
Metadata
Description
A set of key-value pairs, to store metadata related to the resource.
Name
createdAt
Type
string
Description
Time when the device was created.
Example: "2021-02-14T19:38:34Z"
Name
imei
Type
nullable string
Description
The IMEI (international mobile equipment identity) of the device if provided.
Example: "492388841798923"
Name
model
Type
nullable object
Description
Name
name
Type
nullable string
Description
An optional custom name for the device.
Example: "Anna's iPhone 12 Pro"
Name
sims
Type
array
Description
List of SIMs added to this device.
Name
user
Type
nullable object
Description
Users are end consumers of subscriptions. Users can have multiple devices, SIMs, and subscriptions.

Example

{
  "object": "device",
  "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
  "metadata": {},
  "createdAt": "2021-02-14T19:38:34.0Z",
  "imei": "492388841798923",
  "model": {
    "object": "deviceModel",
    "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
    "brand": "Apple",
    "name": "iPhone 12 Pro",
    "simTypes": [
      "eSIM",
      "pSIM"
    ],
    "type": "smartphone"
  },
  "name": "Anna's iPhone 12 Pro",
  "sims": [
    {
      "object": "sim",
      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
      "metadata": {},
      "createdAt": "2021-01-21T19:38:34.0Z",
      "iccid": "89883070000007537119",
      "provider": "p9",
      "status": "inactive",
      "type": "eSIM"
    }
  ],
  "user": {
    "object": "user",
    "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
    "metadata": {},
    "birthday": "2017-07-21",
    "createdAt": "2021-01-21T19:38:34.0Z",
    "email": "jerry@example.com",
    "emailVerified": true,
    "fullName": "Jerry Seinfeld",
    "preferredLocale": "en-US"
  }
}