# Bird Esims API

**Canonical:** https://apis.io/apis/bird/bird-esims-api/  
**Provider:** Bird — https://apis.io/providers/bird/  
**Base URL:** https://platform.bird.com  
**Documentation:** https://docs.bird.com/api

Bird Esims API is one of 85 APIs that [Bird](https://apis.io/providers/bird/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. Tagged areas include esims. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

Prepaid travel eSIMs. Order, install, top up, and manage data connectivity for travelers.

## Operations (33)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/esim/orders` | Order a data package |
| GET | `/v1/esim/orders` | List orders |
| GET | `/v1/esim/orders/{order_id}` | Get an order |
| POST | `/v1/esim/orders/{order_id}/cancel` | Cancel an unfunded order |
| GET | `/v1/esim/offers/{offer_id}/checkout` | Get eSIM checkout options |
| GET | `/v1/esim/offers/{offer_id}/recurrence` | Get recurring eSIM offer terms |
| POST | `/v1/esim/subscriptions` | Create a recurring eSIM subscription |
| GET | `/v1/esim/subscriptions` | List recurring eSIM subscriptions |
| GET | `/v1/esim/subscriptions/{subscription_id}` | Get a recurring eSIM subscription |
| GET | `/v1/esim/subscriptions/{subscription_id}/periods` | List recurring eSIM periods |
| POST | `/v1/esim/subscriptions/{subscription_id}/cancel` | Cancel recurring eSIM renewal |
| POST | `/v1/esim/subscribers` | Create an eSIM subscriber |
| GET | `/v1/esim/subscribers` | List eSIM subscribers |
| GET | `/v1/esim/subscribers/{subscriber_id}` | Get an eSIM subscriber |
| GET | `/v1/esim/sims/{esim_id}/assignment` | Get an eSIM assignment |
| POST | `/v1/esim/sims/{esim_id}/assignment` | Assign an eSIM to a person |
| GET | `/v1/esim/sims` | List eSIMs |
| GET | `/v1/esim/sims/{esim_id}` | Get an eSIM |
| PATCH | `/v1/esim/sims/{esim_id}` | Update an eSIM |
| DELETE | `/v1/esim/sims/{esim_id}` | Release an eSIM |
| GET | `/v1/esim/sims/{esim_id}/credentials` | Get eSIM install credentials |
| POST | `/v1/esim/sims/{esim_id}/credentials/deliver` | Send install credentials to the traveler |
| GET | `/v1/esim/sims/{esim_id}/deliveries` | List an eSIM's credential deliveries |
| POST | `/v1/esim/sims/{esim_id}/install-links` | Create a hosted install link |
| DELETE | `/v1/esim/sims/{esim_id}/install-links/{install_link_id}` | Revoke a hosted install link |
| GET | `/v1/esim/sims/{esim_id}/packages` | List an eSIM's data packages |
| GET | `/v1/esim/sims/{esim_id}/packages/{package_id}` | Get a data package |
| DELETE | `/v1/esim/sims/{esim_id}/packages/{package_id}` | Remove a data package |
| GET | `/v1/esim/sims/{esim_id}/compatible-offers` | List offers an eSIM can take |
| POST | `/v1/esim/sims/{esim_id}/suspend` | Suspend an eSIM |
| POST | `/v1/esim/sims/{esim_id}/resume` | Resume an eSIM |
| GET | `/v1/esim/settings` | Get the eSIM settings |
| PATCH | `/v1/esim/settings` | Update the eSIM settings |

## Machine-readable artifacts (20)

- **OpenAPI** — https://artifacts.apis.io/bird/openapi/bird-esims-api-openapi.yml
- **Documentation** — https://docs.bird.com/api/channels-api/api-reference/messaging
- **Documentation** — https://bird.com/docs
- **APIReference** — https://bird.com/docs/api
- **Webhooks** — https://artifacts.apis.io/bird/asyncapi/messagebird-bird-webhooks.yml
- **ToolCrosswalk** — https://artifacts.apis.io/bird/mcp/messagebird-tool-crosswalk.yml
- **DataModel** — https://artifacts.apis.io/bird/data-model/messagebird-data-model.yml
- **Documentation** — https://developers.messagebird.com/api/sms-messaging/
- **Documentation** — https://developers.messagebird.com/api/voice-calling/
- **Documentation** — https://developers.messagebird.com/api/voice-messaging/
- **Documentation** — https://developers.messagebird.com/api/conversations/
- **AsyncAPI** — https://artifacts.apis.io/bird/asyncapi/messagebird-conversations-asyncapi.yml
- **Documentation** — https://developers.messagebird.com/api/whatsapp
- **Documentation** — https://developers.messagebird.com/api/verify/
- **Documentation** — https://developers.messagebird.com/api/lookup/
- **Documentation** — https://developers.messagebird.com/api/hlr/
- **Documentation** — https://developers.messagebird.com/api/contacts/
- **Documentation** — https://developers.messagebird.com/api/numbers/
- **Documentation** — https://developers.messagebird.com/api/balance/
- **Documentation** — https://developers.messagebird.com/api/integrations/

## Other Bird APIs (12)

- [Bird Customer Data API](https://apis.io/apis/bird/bird-customer-data-api/)
- [Bird Phone Numbers API](https://apis.io/apis/bird/bird-phone-numbers-api/)
- [Bird Identity Verification API](https://apis.io/apis/bird/bird-identity-verification-api/)
- [Bird Touchpoints API](https://apis.io/apis/bird/bird-touchpoints-api/)
- [Bird Accounts API](https://apis.io/apis/bird/bird-accounts-api/)
- [Bird FAQ API](https://apis.io/apis/bird/bird-faq-api/)
- [Bird Intent API](https://apis.io/apis/bird/bird-intent-api/)
- [Bird SMS Messaging API](https://apis.io/apis/bird/bird-sms-messaging-api/)
- [Bird Channels API](https://apis.io/apis/bird/bird-channels-api/)
- [Bird Contacts API](https://apis.io/apis/bird/bird-contacts-api/)
- [Bird Conversations API](https://apis.io/apis/bird/bird-conversations-api/)
- [Bird Legacy MessageBird API](https://apis.io/apis/bird/bird-legacy-messagebird-api/)

## Tags

esims

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/bird/bird-esims-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/bird/.