eSIM API

Build the whole connection.

Bring connectivity into your application through one service model. Connect the catalog to an authorized purchase, follow fulfillment and installation, then help customers manage the service they bought. Keep your customer experience in control of the journey.

Explore the eSIM platform

An integration you can follow

EXAMPLE

BIRD · CONNECTIVITY

One service. Connected records.

1

Discover and select

Read coverage, terms, price and eligibility.

2

Purchase and fulfill

Follow one accepted order to its outcome.

3

Install and use

Resolve private setup and observe first use.

Illustrative integration flow. Follow the current API contract for supported operations and recovery behavior.

Start with the contract

Model the service your customer is buying.

A profile identifies the eSIM, a package describes an allowance and an order records the purchase. A recurring subscription adds billing periods and continuing service. Connect those identities in your application without collapsing their different states.

Read before you write

Discover the offers and effective capabilities for the intended customer. Use published pricing and current eligibility rather than keeping a separate hardcoded catalog in the app.

Keep the accepted intent

Preserve the selected offer and request identity through the purchase. Follow the existing order after an uncertain response, so recovery does not become an accidental second charge.

Build a complete journey

Connect purchase to a working device.

Track the order through financial acceptance and provisioning, then provide a private installation path. Report the actual outcome at each boundary instead of labeling the customer connected when checkout finishes.

Keep credentials private

Resolve installation credentials through the authorized customer experience. Exclude them from telemetry, public Markdown, issue reports and general support messages.

React to observed state

Use the supported events and reads for the service. Retain observation times, handle missing information explicitly and let your interface resume from the state it actually receives.

Operate the integration

Make recovery part of the implementation.

Test a controlled purchase, installation and first use, then an interrupted or refused operation. Use the same service identities to connect support, financial records and lifecycle changes.

Work with your coding agent

Give the agent the current API description and the relevant task guide. Ask it to map supported operations, implement the authorized flow and show evidence for the completed customer outcome.

Carry acquisition through the journey

Keep campaign identifiers with the acquisition and customer handoff. Join them to the recorded business conversion in your application; passing a query parameter is only one part of attribution.

eSIM API questions

Is an eSIM API only an installation-code endpoint?
No. A useful integration also covers offer discovery, purchasing, fulfillment, service state and ongoing management. Installation credentials are one private part of that lifecycle.
Can a coding agent build the integration?
An agent can work from the current API description, task guides and your application. Have it inspect the supported operations and demonstrate a controlled complete journey; do not assume a method exists from a marketing example.
How should we handle an uncertain purchase response?
Keep the original request and order identity, then use the documented recovery behavior to establish its outcome. Starting a fresh purchase can create another charge or service.
What belongs in conversion measurement?
Record the business outcome you intend to optimize, such as a completed purchase or verified first use. Preserve acquisition context through the relevant handoff and join it to that outcome without including private installation credentials.

Put it into practice.

Continue with the documentation, guides and examples for this topic. Resources are in English.

Get an implementation brief

Start with a complete integration path.

Map the supported catalog, purchase and installation operations to your application. Rehearse recovery with the same order before expanding the integration.

Start with one channel.
Add the others when you're ready.

A test API key is yours immediately. Production unlocks when you add a payment method and verify a sender.

Using Claude Code, Cursor, or Codex? Copy a setup prompt and your agent installs the Bird CLI and skills for you. Pick yours:

Cursor