Skip to main content
GET
/
subscribers
/
{subscriberId}
Get subscriber
curl --request GET \
  --url https://apiv2.example.com/subscribers/{subscriberId} \
  --header 'X-Api-Key: <api-key>'
{
  "subscriberId": "<string>",
  "name": "<string>",
  "customer": {
    "customerId": "<string>",
    "name": "<string>"
  },
  "email": "[email protected]",
  "address": {
    "street1": "500 S Main St",
    "city": "Natick",
    "zip": "01701",
    "country": "US",
    "street2": "Apt 1",
    "state": "CA",
    "region": "<string>",
    "attention": "<string>"
  },
  "subscriptions": [
    {
      "subscriptionId": "<string>",
      "status": "PENDING",
      "type": "<string>",
      "display": "<string>",
      "msisdn": "<string>",
      "customer": {
        "customerId": "<string>",
        "name": "<string>"
      },
      "sim": {
        "esim": true,
        "imei": "<string>",
        "iccid": "<string>"
      },
      "activatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "productOffering": {
        "productOfferingId": "<string>",
        "name": "<string>",
        "price": {
          "currency": "USD",
          "priceType": "ONE_TIME",
          "discount": 5,
          "netPrice": 5,
          "boundMonths": 12,
          "billingCycle": {
            "period": "MONTHLY",
            "interval": 1
          }
        },
        "group": {
          "productOfferingGroupId": "mobile-plans",
          "name": "Mobile Plans",
          "category": "SUBSCRIPTION_CELL",
          "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
          "internalDescription": "Core mobile offerings targeting consumer and business segments"
        }
      },
      "subscriber": {
        "subscriberId": "<string>",
        "name": "<string>",
        "email": "[email protected]",
        "address": {
          "street1": "500 S Main St",
          "city": "Natick",
          "zip": "01701",
          "country": "US",
          "street2": "Apt 1",
          "state": "CA",
          "region": "<string>",
          "attention": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "extensions": {},
      "pendingMsisdn": {
        "msisdn": "<string>",
        "scheduledAt": "2023-12-25"
      },
      "pendingStatus": {
        "status": "PENDING",
        "scheduledAt": "2023-12-25"
      },
      "pendingProductOffering": {
        "scheduledAt": "2023-12-25",
        "product": {
          "productOfferingId": "<string>",
          "name": "<string>",
          "price": {
            "currency": "USD",
            "priceType": "ONE_TIME",
            "discount": 5,
            "netPrice": 5,
            "boundMonths": 12,
            "billingCycle": {
              "period": "MONTHLY",
              "interval": 1
            }
          },
          "group": {
            "productOfferingGroupId": "mobile-plans",
            "name": "Mobile Plans",
            "category": "SUBSCRIPTION_CELL",
            "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
            "internalDescription": "Core mobile offerings targeting consumer and business segments"
          }
        }
      },
      "porting": {
        "msisdn": "<string>",
        "status": "PENDING",
        "direction": "INBOUND",
        "scheduledAt": "2023-12-25"
      },
      "cancelledAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

​
subscriberId
string
required

The unique identifier of the subscriber.

Response

A subscriber object.

A subscriber is a person or entity that has a subscription.

​
subscriberId
string
required

The unique identifier of the subscriber.

​
name
string
required

The name of the subscriber.

​
customer
object
required

Customer information embedded in responses. Sensitive details require separate API calls with appropriate authorization.

​
email
string<email>

Optional email address of the subscriber.

​
address
object

The address of the subscriber. In the US, this refers to the E911 address associated with the subscriber's phone number, which is used for emergency services.

​
subscriptions
object[]

List of subscriptions associated with the subscriber.

Typically a subscriber has exactly one subscription, but in rare cases, a subscriber may have multiple subscriptions.