# ZIM API

> This is version `3.1` of this API documentation. Last update on Oct 28, 2026.
> REST API for B2B partners to browse the ZIM plan catalogue, purchase travel eSIM plans, and manage the resulting eSIMs and Subscriptions.
> 
> **Version 3.1 contains breaking changes** — see the *Changelog & migration to 3.1* topic before upgrading an existing integration.

OpenAPI file: https://bump.sh/zim/doc/esim-api.yaml

## Servers

- Production: https://zim.api.zimconnections.com (Production)

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


## Topics

### [Changelog & migration to 3.1](https://bump.sh/zim/doc/esim-api/topic/topic-changelog-migration-to-3-1.md)

### [Authentication](https://bump.sh/zim/doc/esim-api/authentication.md)

### [Pagination](https://bump.sh/zim/doc/esim-api/topic/topic-pagination.md)

### [Errors](https://bump.sh/zim/doc/esim-api/topic/topic-errors.md)


## Endpoints

### [eSIMs](https://bump.sh/zim/doc/esim-api/group/endpoint-esims.md)

- [Retrieve all eSIMs](https://bump.sh/zim/doc/esim-api/operation/operation-get-esims.md)

- [Retrieve an eSIM](https://bump.sh/zim/doc/esim-api/operation/operation-get-esims-esimid.md)

- [Retrieve an eSIM's installation details](https://bump.sh/zim/doc/esim-api/operation/operation-get-esims-esimid-config.md)

- [Retrieve a short-lived QR code URL](https://bump.sh/zim/doc/esim-api/operation/operation-get-esims-esimid-qrcode-url.md)


### [Subscriptions](https://bump.sh/zim/doc/esim-api/group/endpoint-subscriptions.md)

- [Retrieve all Subscriptions](https://bump.sh/zim/doc/esim-api/operation/operation-get-subscriptions.md)

- [Retrieve a Subscription](https://bump.sh/zim/doc/esim-api/operation/operation-get-subscriptions-subscriptionid.md)

- [Cancel a Subscription (deprecated)](https://bump.sh/zim/doc/esim-api/operation/operation-delete-subscriptions-subscriptionid.md)

- [Cancel a Subscription](https://bump.sh/zim/doc/esim-api/operation/operation-post-subscriptions-subscriptionid-cancel.md)

- [Latest Subscription's consumption report](https://bump.sh/zim/doc/esim-api/operation/operation-get-subscriptions-subscriptionid-activity-latest.md)

- [List Plans compatible for a top-up](https://bump.sh/zim/doc/esim-api/operation/operation-get-subscriptions-subscriptionid-compatible-plans.md)


### [Catalogue](https://bump.sh/zim/doc/esim-api/group/endpoint-catalogue.md)

- [Get supported Destinations](https://bump.sh/zim/doc/esim-api/operation/operation-get-destinations-supported-destinations.md)

- [Get supported Destinations (alias)](https://bump.sh/zim/doc/esim-api/operation/operation-get-destinations-supported_destinations.md)

- [Get Destination coverage](https://bump.sh/zim/doc/esim-api/operation/operation-get-destinations-iso3.md)

- [List or search Plans](https://bump.sh/zim/doc/esim-api/operation/operation-get-plans.md)

- [Retrieve a Plan](https://bump.sh/zim/doc/esim-api/operation/operation-get-plans-details-planid.md)

- [Search for Plans](https://bump.sh/zim/doc/esim-api/operation/operation-post-plans-search.md)

- [Search UK domestic Plans](https://bump.sh/zim/doc/esim-api/operation/operation-post-plans-search-domestic.md)

- [Get local Plans for a Destination (deprecated)](https://bump.sh/zim/doc/esim-api/operation/operation-get-plans-iso3-local.md)

- [Get regular local Plans for a Destination (deprecated)](https://bump.sh/zim/doc/esim-api/operation/operation-get-plans-iso3-local-regular.md)

- [Get unlimited local Plans for a Destination (deprecated)](https://bump.sh/zim/doc/esim-api/operation/operation-get-plans-iso3-local-unlimited.md)


### [Orders](https://bump.sh/zim/doc/esim-api/group/endpoint-orders.md)

- [Retrieve all Orders](https://bump.sh/zim/doc/esim-api/operation/operation-get-orders.md)

- [Retrieve an Order](https://bump.sh/zim/doc/esim-api/operation/operation-get-orders-orderid.md)

- [Cancel an Order](https://bump.sh/zim/doc/esim-api/operation/operation-delete-orders-orderid.md)

- [Create an Order](https://bump.sh/zim/doc/esim-api/operation/operation-post-v2-orders.md)

- [Create Order with wallet (deprecated)](https://bump.sh/zim/doc/esim-api/operation/operation-post-orders-with-wallet.md)




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