> For the complete documentation index, see [llms.txt](https://bump.sh/zim/doc/esim-api/llms.txt)

# List or search Plans

> GET /plans
> 
> 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`, `limit` or nothing): returns
> `PaginatedPlans`. Plans are sorted by Destination / Region name,
> then data allowance (unlimited last), then duration.
> * **Search** — when `destination` is given without `page` / `limit`,
> or when any of `region`, `scope`, `category`, `planType`,
> `bestSeller`, `currency`, `discountCode`, `groupByRegion` is
> given: returns a non-paginated array of
> `Plan`, or of `PlanRegionGroup` when `groupByRegion=true`. A
> search requires `destination` or `region`.
> 
> 
> UK domestic plans are not returned here; use `POST /plans/search/domestic`.



## Servers
- Production: https://zim.api.zimconnections.com (Production)
- Sandbox: https://zim.api.dev.zimconnections.com (Sandbox)


## Authentication methods
- App identifier


## Parameters


### Query parameters

- **destination** (string)
  ISO Alpha-3 code of the Destination

- **region** (string)
  Region abbreviation. Takes precedence over `destination` and `scope`.

- **scope** (string)
  * `LOCAL` - single Destination * `REGIONAL` - a Region (several Destinations) * `GLOBAL` - worldwide coverage

- **category** (string)

- **planType** (string)
  * `DATA` - Data-only Plans * `VOICE_AND_DATA` - Plans including voice (and SMS) in addition to data

- **bestSeller** (boolean)
  If `true`, returns only the two best-selling Plans

- **currency** (string)
  Only keep prices in this currency

- **discountCode** (string)
  Discount code applied to the returned prices (see `Price.discountedFrom`)

- **groupByRegion** (boolean)
  Group the results by Region (`PlanRegionGroup[]`)

- **page** (integer)

- **limit** (integer)



## Responses
### 200
Plans fetched successfully

#### Body: application/json (object)
- **data** (array[object])

- **meta** (object)


### 400
Invalid request or refused by a business rule

#### Body: application/json (object)
- **statusCode** (integer)

- **message** (string | array[string])
  Human-readable reason, or one entry per invalid property for validation errors

- **error** (string)



[Powered by Bump.sh](https://bump.sh)
