Build mobile data into your app.

Use the eSIM API to discover data offers, purchase packages and deliver private installation links from your application. Keep customers in your own account experience for reported balances, compatible top-ups and recurring purchases where available.

Get Started Contact Sales

Start with the available offers.

Use a server-side API key with eSIM read permission to explore the catalog. This example lists offers without purchasing a package.

bird esim offers list

From offer to order

Turn an offer into a recoverable purchase.

Read the offer’s coverage, allowance and validity, then get its current checkout price. Your organization wallet funds the purchase. Save the resulting order so the customer can return to it while Bird provisions the eSIM and data package.

Present the accepted terms

Send the accepted offer revision and price with the order. If the terms change before purchase, show the updated quote for acceptance. Recurring purchases have their own available terms and schedule.

Recover without another purchase

Save an idempotency key before creating an order and reuse it with the same request if the response is interrupted. If you have the order ID, read that order first to find out whether it completed.

Hosted installation

Send setup the customer can open.

After the order completes, create a hosted installation link or send it by email or SMS. The customer opens device-specific instructions without signing into a Bird workspace. Track message delivery separately from installation and the first mobile-data connection.

Control installation access

Installation credentials use separate API permissions. Check the hosted link’s expiry and revoke it if it reaches the wrong person. Revoking a link stops future access through it; it does not disable a profile already installed.

Read package balances

Show purchased allowance, expiry and reported consumption with its observation time. When usage is unavailable, keep it unknown so customers can distinguish their package allowance from a measured remaining balance.

Ongoing purchases

Let customers add data to the same eSIM.

List compatible offers for an existing eSIM before presenting a top-up. A completed top-up adds a package to the installed profile, so the customer can keep using that eSIM without another installation.

Schedule recurring packages

Where an offer supports renewal, assign the person using the eSIM and accept its recurring price and cadence. Follow each period’s payment and package delivery, and let the customer stop future renewal.

Keep customer access in your app

Authenticate your customers and authorize access to their own orders and eSIMs. A workspace API key can access resources for several customers, so keep it on your server and connect each resource to the correct account.

Build with the right reference

eSIM API guideFollow the setup, requirements and operational checks.Get started with eSIMChoose an offer and follow a controlled purchase-to-first-use journey.Plans and pricingReview coverage, allowance, validity and the published terms.

eSIM API questions

What can I build with the eSIM API?

Build offer discovery, data-package purchases, installation delivery and ongoing package management into your app. Customers can buy compatible top-ups and enroll in recurring purchases where available. Your application owns customer authentication and any payment it collects from them.

What do I need to make a purchase?

Use a Bird workspace, a server-side API key with the required eSIM permissions and organization wallet funds. Review the offer, checkout terms and identification requirements before buying. Reading credentials and creating or sending installation links require separate credential permissions.

How should I handle an interrupted purchase response?

Read the existing order if you have its ID. Otherwise, repeat the saved create request with its original idempotency key. Follow that order to completion or failure before creating a replacement that could cause another charge.

Does a completed order mean the customer is online?

A completed order identifies the purchased eSIM and package. The customer still needs to install the profile on a compatible device and test mobile data in a covered destination. Installation and balance reports can arrive after the device result.

Connect the complete service

eSIM installationHelp customers install on their device and get connected with clear guidance.Usage and top-upsShow allowance and expiry, then offer compatible additional data.Connectivity operationsResolve purchase, installation and package issues with the existing service records.eSIM resource libraryBrowse practical guides, explained answers and technical references.

Scale without
losing control.

Organize teams in workspaces, control API access, and trace changes through audit logs.

HarborOrganization

WorkspacesProductionSandbox

Delivery agent

API key · Customer operations team

Active

PermissionsAccess

EmailRead & write

SMSRead & write

ALAlex Lee AdminPermissions updated

Audit log

Production

Workspace: Production
Resource: Delivery agent
WhatsApp: Read accessRead & write

Succeeded

Explore Enterprise

Start with eSIM.
Build across channels with Bird.