Version: v1.0

Subscriptions Reports

Truphone Connect supports reporting using the Subscriptions API so that our users can extract their own subscription reports using a singel API. The endpoint supports the following filters in order to tailor your reports to your needs.

Available Filters#

StatusDescription
iccidfilter for a specific iccid
emailfilter for a specific email
product-idfilter for subscriptions with a specific product id
beforesubscriptions before a certain date (in the ISO 8601 Date-time format: yyyy-MM-ddTHH:mm:ssZ)
aftersubscriptions after a certain date (in the ISO 8601 Date-time format: yyyy-MM-ddTHH:mm:ssZ)
sizepage size to be used
pagepage number

Example Request#

curl -X GET \
https://services.truphone.com/connect-api/v1/subscription?before=2020-04-24T15:39:02.002Z&size=10&page=2 \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-H 'X-Correlation-ID: unique-id-from-requester-123'

Example Response#

[
{
"id": "xoCdHNs78yvyOSmdn0eaD6FHRIO572_lPNyUxDGgLnI=",
"status": "DEPLETED",
"activationDate": "2020-04-01T12:00:00Z",
"expirationDate": "2020-04-16T12:00:00Z",
"createdDate": "2020-03-19T15:51:41Z",
"product": {
"id": "Q-hzHc6EErZPQcgw2L02_nDdruGtr6lDrM-jmja_xuE=",
"name": "1GB 15-Day - Truphoneinternal - Tier2 Data Bundle",
"period": 0,
"period_unit": "DAYS",
"plan_id": "TruphoneinternalPlan_Id"
},
"iccid": "8912782347382323",
"device_id": "12345657",
"auto_renew": "false"
},
{
"id": "mEbXDbnruRowxX1ybirQK-adwS0edrvcUs4VKW9QWlM=",
"status": "DEPLETED",
"activationDate": "2020-03-24T12:55:46Z",
"expirationDate": "2020-04-08T12:55:46Z",
"createdDate": "2020-03-24T12:55:54Z",
"product": {
"id": "Q-hzHc6EErZPQcgw2L02_nDdruGtr6lDrM-jmja_xuE=",
"name": "1GB 15-Day - Truphoneinternal - Tier2 Data Bundle",
"period": 0,
"period_unit": "DAYS",
"plan_id": "TruphoneinternalPlan_Id"
},
"iccid": "8912782347382323",
"device_id": "123456789",
"auto_renew": "false"
},
{
"id": "tl_6a2eO00tBm67k5l-HAqX1Oswd0gaSC-ucQRcTpcw=",
"status": "DEPLETED",
"activationDate": "2020-03-24T12:58:17Z",
"expirationDate": "2020-04-08T12:58:17Z",
"createdDate": "2020-03-24T12:58:21Z",
"product": {
"id": "Q-hzHc6EErZPQcgw2L02_nDdruGtr6lDrM-jmja_xuE=",
"name": "1GB 15-Day - Truphoneinternal - Tier2 Data Bundle",
"period": 0,
"period_unit": "DAYS",
"plan_id": "TruphoneinternalPlan_Id"
},
"iccid": "8912782347382323",
"device_id": "123456789",
"auto_renew": "false"
},
{
"id": "eJWIyFew88qMPz7ymEJ1fQh6LnlniH3ixbPG0VynPYA=",
"status": "DEPLETED",
"activationDate": "2020-03-24T13:00:07Z",
"expirationDate": "2020-04-08T13:00:07Z",
"createdDate": "2020-03-24T13:00:09Z",
"product": {
"id": "Q-hzHc6EErZPQcgw2L02_nDdruGtr6lDrM-jmja_xuE=",
"name": "1GB 15-Day - Truphoneinternal - Tier2 Data Bundle",
"period": 0,
"period_unit": "DAYS",
"plan_id": "TruphoneinternalPlan_Id"
},
"iccid": "8912782347382323",
"device_id": "123456789",
"auto_renew": "false"
},
{
"id": "mKDI7e30fYGKTIQwKZvYnixEhsvSQYBE2523XapjgHk=",
"activationDate": "2020-03-25T16:39:42Z",
"expirationDate": "2020-04-09T16:39:42Z",
"createdDate": "2020-03-25T16:39:47Z",
"product": {
"id": "Q-hzHc6EErZPQcgw2L02_nDdruGtr6lDrM-jmja_xuE=",
"name": "1GB 15-Day - Truphoneinternal - Tier2 Data Bundle",
"period": 0,
"period_unit": "DAYS",
"plan_id": "TruphoneinternalPlan_Id"
},
"iccid": "8912782347382323",
"device_id": "123456789",
"auto_renew": "false"
},
{
"id": "p5N_LjvSxfdtVv9Rfi7nDi8zc_QPiVus6L-k6kk6lNQ=",
"status": "DEPLETED",
"activationDate": "2020-03-25T17:46:09Z",
"expirationDate": "2020-04-09T17:46:09Z",
"createdDate": "2020-03-25T17:46:13Z",
"product": {
"id": "Q-hzHc6EErZPQcgw2L02_nDdruGtr6lDrM-jmja_xuE=",
"name": "1GB 15-Day - Truphoneinternal - Tier2 Data Bundle",
"period": 0,
"period_unit": "DAYS",
"plan_id": "TruphoneinternalPlan_Id"
},
"iccid": "8912782347382323",
"device_id": "123456789",
"auto_renew": "false"
},
{
"id": "yLCLVb967QI3TrCTL4vDlAes8TGQD9AFlwL6JfGVQP8=",
"status": "DEPLETED",
"activationDate": "2020-03-26T16:26:05Z",
"expirationDate": "2020-04-10T16:26:05Z",
"createdDate": "2020-03-26T16:26:09Z",
"product": {
"id": "Q-hzHc6EErZPQcgw2L02_nDdruGtr6lDrM-jmja_xuE=",
"name": "1GB 15-Day - Truphoneinternal - Tier2 Data Bundle",
"period": 0,
"period_unit": "DAYS",
"plan_id": "TruphoneinternalPlan_Id"
},
"iccid": "8912782347382323",
"device_id": "123456789",
"auto_renew": "false"
}
]