| eSIM |
A SIM that is built into the phone and loaded with a mobile plan over the internet, instead of a plastic card. |
| Plan |
What the customer buys: a data allowance for a country or region, valid for a set number of days. The API calls it a package, and so do these docs. |
| Package |
The API’s name for a plan. Its id looks like pkg_10482. |
| Order |
A purchase of one package, one or more times. Each unit becomes one eSIM. |
| Partially completed |
An order where some eSIMs were issued and the rest were refunded. |
| Top-up |
A package added to an eSIM the customer already has, so they do not need to install a new one. |
| Top-up package |
A package that can be added to one particular eSIM. Ask the API for the list of each eSIM. |
| Balance |
The money on your partner account that orders and top-ups are charged to. The Business portal calls it your wallet. |
| Low-balance threshold |
The level you set in the portal under Settings. When an order takes your balance below it, a balance.low event is sent. |
| Partner price |
What a package costs you: the eSIMify retail price less your partner discount. It is the price of a package. |
| ICCID |
The serial number of an eSIM, 19 or 20 digits long. It identifies the eSIM in the API. Sandbox ICCIDs start with 8999999. |
| EID |
The serial number of the eSIM chip inside a phone. It identifies the device, not the plan. |
| SM-DP+ |
The server a phone downloads an eSIM from. Its address is part of every activation string. |
| Activation code |
The code that tells the SM-DP+ server which eSIM to hand to the phone. |
| LPA string |
The SM-DP+ address and activation code joined into one line, in the form LPA:1$address$code. A QR code is this string as a picture. |
| Data roaming |
The phone setting that lets a SIM use a network outside its home country. It must be on for a travel eSIM to work. |
| APN |
The network setting a phone uses to reach the internet. Travel eSIMs normally set it automatically. |
| Validity |
How long a plan lasts once it starts, in days. It starts when the eSIM is first used. |
| Depleted |
The status of an eSIM that has used all of its data. A top-up makes it active again. |
| Mobile network provider |
The company whose network the eSIM uses abroad. eSIMify buys the plan from it. Error messages call it the supplier. |
| API key |
The secret your server sends with every request. Test keys start with sk_test_ and live keys with sk_live_. |
| Mode |
test or live. Set by the key you use. |
| Sandbox |
Test mode. Orders work but nothing is bought or charged. The Business portal labels it Test. |
| Idempotency key |
A value you send with a request so that sending it twice has the same effect as sending it once. |
| Customer reference |
Your own identifier for a sale, sent as customer_ref. |
| Cursor |
A marker for where the next page of a list starts. |
| Event |
A record that something happened, such as order.completed. |
| Sequence |
A number on each event that grows with every event on your account. Use it to put events in order. |
| Webhook |
A request eSIMify sends to your server to deliver an event. |
| Endpoint |
In webhooks, the HTTPS address on your server that eSIMify sends events to. In the reference, a method and path of the API. |
| Delivery |
One event being sent to one webhook endpoint, with up to 8 attempts. |
| Signing secret |
The secret used to sign webhooks to one address. It starts with whsec_. |
| IP allowlist |
The list of addresses a key may be used from. |
| Request id |
The id of one API request, such as req_7c1d92ab34ef5a60. It is in the X-Request-Id header of every response. Quote it to support. |
| White-label |
eSIMify sends nothing to your customer. Delivery and all messages are yours. |
| Business portal |
Where you manage your partner account, at business.esimify.in. Keys, webhooks and logs are under Developers. |
