Breaking change in 3.1: this endpoint is now paginated.
Returns the Subscriptions of the authenticated User, most recently updated first. Users with an account-wide role can list the whole Account with accountNanoID, or a specific User with userNanoID.
Query parameters
-
Minimum value is
1. Default value is1. -
Minimum value is
1, maximum value is20. Default value is10. -
List the Subscriptions of the whole Account. Requires an account-wide role (
Owner,Admin,Purchaser,Analyst). -
List the Subscriptions of this User of your Account
-
Statuses:
PROCESSING- The Subscription is being processed and should be ready soonPENDING- The Subscription is ready and is pending first use by the UserACTIVE- The Subscription is currently active and used by the UserEXPIRED- The Subscription has expired and is no longer validCANCEL_PENDING- A cancellation was requested and is awaiting confirmation from the networkCANCELLED- The Subscription has been cancelledDEPLETED- The allocation of the Subscription has been fully consumed by the User
Values are
PROCESSING,PENDING,ACTIVE,EXPIRED,CANCEL_PENDING,CANCELLED, orDEPLETED. -
If
true, each Subscription includes its latest consumption report inactivityDefault value is
false.
GET
/subscriptions
curl \
--request GET 'https://zim.api.zimconnections.com/subscriptions' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-App-Identifier: $API_KEY"
Response examples (200)
{
"data": [
{
"id": "subs_BiPtvfzYKwcyNMNvTGmLO",
"status": "ACTIVE",
"planID": "plan_guaGulGcrqgTYboPvetgu",
"orderID": "ordr_GMAVA4ISiqfWSG0ArGOzB",
"userID": "user_yf95A86RIkVxau2gzBsjV",
"accountID": "acct_ozxEbkTyvLPhhoglcALXE",
"esimID": "esim_igFqGZhkRTHb0UNiRuAAA",
"expirationDate": "2026-11-26T14:41:02.501Z",
"createdAt": "2026-10-12T14:41:02.501Z",
"cancelAtPeriodEnd": false,
"plan": {
"id": "plan_guaGulGcrqgTYboPvetgu",
"dataValue": 10,
"dataUnit": "GB"
}
}
],
"meta": {
"page": 1,
"limit": 10,
"totalItems": 1,
"totalPages": 1,
"hasNext": false,
"hasPrev": false
}
}
Response examples (400)
{
"statusCode": 400,
"message": [
"property foo should not exist"
],
"error": "Bad Request"
}
Response examples (401)
{
"statusCode": 401,
"message": "Unauthorized"
}
Response examples (403)
{
"statusCode": 403,
"message": "Forbidden resource",
"error": "Forbidden"
}