Single entry point for the plan catalogue. The response shape depends on the query:
- Paginated list — when no search filter is given (only
destination,page,limitor nothing): returnsPaginatedPlans. Plans are sorted by Destination / Region name, then data allowance (unlimited last), then duration. - Search — when
destinationis given withoutpage/limit, or when any ofregion,scope,category,planType,bestSeller,currency,discountCode,groupByRegionis given: returns a non-paginated array ofPlan, or ofPlanRegionGroupwhengroupByRegion=true. A search requiresdestinationorregion.
UK domestic plans are not returned here; use POST /plans/search/domestic.
Query parameters
-
ISO Alpha-3 code of the Destination
-
Region abbreviation. Takes precedence over
destinationandscope. -
LOCAL- single Destination *REGIONAL- a Region (several Destinations) *GLOBAL- worldwide coverage
Values are
LOCAL,REGIONAL, orGLOBAL. -
Values are
REGULAR,UNLIMITED, orMIXED. -
DATA- Data-only Plans *VOICE_AND_DATA- Plans including voice (and SMS) in addition to data
Values are
DATAorVOICE_AND_DATA. -
If
true, returns only the two best-selling Plans -
Only keep prices in this currency
Values are
usd,eur,gbp,chf, orjpy. -
Discount code applied to the returned prices (see
Price.discountedFrom) -
Group the results by Region (
PlanRegionGroup[]) -
Minimum value is
1. Default value is1. -
Minimum value is
1, maximum value is1000. Default value is10.
GET
/plans
curl \
--request GET 'https://zim.api.dev.zimconnections.com/plans' \
--header "X-App-Identifier: $API_KEY"
Response examples (200)
Paginatedplans
{
"data": [
{
"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"
}
],
"meta": {
"page": 1,
"limit": 10,
"totalItems": 42,
"totalPages": 5,
"hasNext": true,
"hasPrev": false
}
}
[
{
"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"
}
]
[
{
"region": "Europe",
"supportedCountries": [
{
"name": "United Kingdom",
"isoAlpha3": "GBR",
"regions": [
{
"name": "Europe",
"abbreviation": "EU"
}
],
"scopes": {
"local": true,
"regional": true,
"global": true
}
}
],
"plans": [
{
"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"
}
]
}
]
Response examples (400)
{
"statusCode": 400,
"message": [
"property foo should not exist"
],
"error": "Bad Request"
}