User

Users are end consumers of subscriptions. Users can have multiple devices, SIMs, and subscriptions.

  • Name
    object
    Type
    string
    Description

    Type of object is always user.

    Allowed values: user 
  • Name
    id
    Type
    string
    Description

    Unique identifier for the user.

    Example: "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
  • Name
    metadata
    Type
    Metadata
    Description

    A set of key-value pairs, to store metadata related to the resource.

  • Name
    birthday
    Type
    nullable string
    Description

    The birthday of the user.

    Example: "2017-07-21"
  • Name
    createdAt
    Type
    string
    Description

    Time when the user was created.

    Example: "2021-01-21T19:38:34Z"
  • Name
    email
    Type
    string
    Description

    The primary email address of the user.

    Example: "jerry@example.com"
  • Name
    emailVerified
    Type
    boolean
    Description

    Whether the user's primary email address is verified or not.

    Example: true
  • Name
    fullName
    Type
    nullable string
    Description

    The user's full name. Required for some Plans.

    Example: "Jerry Seinfeld"
  • Name
    preferredLocale
    Type
    string
    Description

    The user's locale preference represented as an IETF language tag.

    Example: "en-US"

Example

{
  "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"
}