Get single subscriber

GET p8auth/subscribers/{id}

Example Request

GET /api/v1/p8auth/subscribers/1 HTTP/1.1
Host: tph.io
X-Token: c9c0a840-b5f1-4e0e-84da-e8a4eedfc63b

Response Structure

  • data: array[object]
    • id: int
    • reseller: string
    • company: string
    • username: string
    • product: string
    • network: string
    • ip_address: string
    • provider: string
    • sim_number: string
    • is_capped: bool
    • is_suspended: bool
    • has_schedule: bool
    • status: string
    • has_quota: bool
    • quota_is_capped: bool
    • soft_cap: int
    • hard_cap: int
    • top_up: int
    • top_ups_applied: int
    • max_allowed_top_ups: int
    • max_top_up_data: int
    • max_sessions: int
    • puk_number: string
    • description: string
    • has_daily_notifications: bool
    • has_threshold_notifications: bool
    • has_sms_notifications: bool
    • usage: object
      • inbundle: int
      • outbundle: int
      • top_up: int
    • quotas: object
      • fixed_quota: array
        • quota: string
        • used: string
      • usage_quota: array
        • quota: string
        • top_up: string
        • in_bundle_used: string
        • out_bundle_used: string
        • top_up_used: string
    • created_at: string ("2020-01-01T00:00:00+00:00")
    • updated_at: string ("2020-01-01T00:00:00+00:00")
    • labels: array[object]
      • data: array[object]
        • id: int
        • name: string
        • type_id: int
    • notification_email_addresses: object
      • data: array[object]
        • email: string
    • notification_sms_numbers: object
      • data: array[object]
        • sms_number: string

Example Response

{
  "data":{
    "id":3,
    "reseller":"Example Reseller",
    "company":"Example Customer",
    "username":"1212121212",
    "product":"Example APN Product",
    "network":"Network 1",
    "ip_address":"192.168.0.2",
    "provider":"Provider 1",
    "sim_number":"0123456789",
    "is_capped":false,
    "is_suspended":false,
    "has_schedule":false,
    "status":"Enabled",
    "has_quota":false,
    "quota_is_capped":false,
    "soft_cap":524288000,
    "hard_cap":1073741824,
    "top_up":null,
    "top_ups_applied":0,
    "max_allowed_top_ups":null,
    "max_top_up_data":null,
    "max_sessions":1,
    "puk_number":"",
    "description":"Example Subscriber",
    "has_daily_notifications":true,
    "has_threshold_notifications":true,
    "has_sms_notifications":false,
    "usage":{
      "inbundle":null,
      "outbundle":null,
      "top_up":null
    },
    "quotas":{
      "fixed_quota":null,
      "usage_quota":null
    },
    "created_at":"2018-04-24T16:13:35+00:00",
    "updated_at":"2018-04-25T10:35:24+00:00",
    "labels":{
      "data":[
        {
          "id":1,
          "name":"Label 1",
          "type_id":1
        }
      ]
    },
    "notification_email_addresses":{
      "data":[
        {
          "email":"email1@example.com"
        }
      ]
    },
    "notification_sms_numbers":{
      "data":[

      ]
    }
  }
}