Returns a Subscription from its ID. activity is filled unless the Subscription is CANCELLED, DEPLETED or EXPIRED.
GET
/subscriptions/{subscriptionID}
curl \
--request GET 'https://zim.api.dev.zimconnections.com/subscriptions/subs_BiPtvfzYKwcyNMNvTGmLO' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-App-Identifier: $API_KEY"
Response examples (200)
{
"id": "subs_BiPtvfzYKwcyNMNvTGmLO",
"status": "PROCESSING",
"esimID": "esim_kNsYsgLWJCesLTLsjoRGp",
"planID": "plan_guaGulGcrqgTYboPvetgu",
"orderID": "ordr_GMAVA4ISiqfWSG0ArGOzB",
"userID": "user_yf95A86RIkVxau2gzBsjV",
"accountID": "acct_ozxEbkTyvLPhhoglcALXE",
"expirationDate": "2026-05-04T09:42:00Z",
"createdAt": "2026-05-04T09:42:00Z",
"plan": {
"id": "plan_guaGulGcrqgTYboPvetgu",
"name": "France - 10GB - 14 days",
"scope": "LOCAL",
"category": "REGULAR",
"type": "DATA",
"isRecurring": false,
"recurringInterval": "DAILY",
"destination": {
"name": "United Kingdom",
"isoAlpha3": "GBR",
"regions": [
{
"name": "Europe",
"abbreviation": "EU"
}
],
"scopes": {
"local": true,
"regional": true,
"global": true
}
},
"region": {
"name": "Europe",
"abbreviation": "EU"
},
"dataUnit": "GB",
"dataValue": 10,
"callUnit": "MINUTES",
"callValue": 100,
"smsUnit": "SMS",
"smsValue": 100,
"durationUnit": "DAYS",
"durationValue": 14,
"features": [
{
"name": "HOTSPOT",
"category": "UTILITY"
}
],
"prices": [
{
"currencyISO": "usd",
"value": 490,
"minorUnitsExponent": 2,
"discountedFrom": 590
}
],
"createdAt": "2026-05-04T09:42:00Z"
},
"activity": {
"currentBalanceBytes": 42.0,
"spentBalanceBytes": 42.0,
"initialBalanceBytes": 42.0,
"lastUpdatedAt": "2026-05-04T09:42:00Z"
},
"cancelAtPeriodEnd": false,
"cancelEffectiveDate": "2026-05-04T09:42:00Z"
}
Response examples (401)
{
"statusCode": 401,
"message": "Unauthorized"
}
Response examples (404)
{
"statusCode": 404,
"message": "Record not found",
"error": "Not Found"
}