POSTeSIM Management
Top Up eSIM
This endpoint allows a business to either top up an existing eSIM (previously created via the Create eSIM endpoint), or purchase a new data plan for an existing eSIM.
Endpoint
POSThttps://api.sotel.com/api/esim/data-plan/purchase
Authentication
Requires a bearer token obtained from the /authenticate endpoint. Include it in the Authorization header.
Authorization: Bearer {token}Request Body
| Name | Type | Required | Description |
|---|---|---|---|
iccid | string | Required | The Integrated Circuit Card Identifier (ICCID) of the eSIM that will receive the top-up or new plan. |
productId | string | Required | The unique identifier of the data plan to apply as a top-up. Obtain this from the Get Data Plans endpoint. |
iso3 | string | Required | ISO alpha-3 country code for the eSIM (e.g. "USA", "GBR", "NGA"). |
Request Example
{
"iccid": "8910300000045513278",
"productId": "21170170",
"iso3": "NLD"
}Response
eSIM topped up successfully. Returns updated eSIM details with the new plan information.
Response
{
"data": {
"sim": {
"id": 8,
"iccid": "8910300000045513278",
"productId": "21170170",
"imsi": "310840118755316",
"state": "INACTIVE",
"lastOperationDate": "2025-12-23 19:58:29",
"activationCode": "TN20250825145316F4221A9A",
"smdp": "consumer.e-sim.global",
"purchaseDate": "2026-06-04T15:48:50.198+01:00"
},
"dataPlan": {
"productId": "21170170",
"name": "Netherlands 1GB 5 days",
"dataUsageAllowance": 1,
"timeAllowance": 5,
"country": "Netherlands",
"iso3": "NLD",
"region": "Europe"
}
}
}Code Examples
curl -X POST 'https://api.sotel.com/api/esim/data-plan/purchase' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
"iccid": "8901260882902400001",
"productId": "21170170",
"iso3": "NLD"
}'Try It
Try It
Fill in the parameters to generate a cURL command
Request Body
Generated cURL
curl -X POST 'https://api.sotel.com/api/esim/data-plan/purchase' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
-d '{
"iccid": "{iccid}",
"productId": "{productId}",
"iso3": "{iso3}"
}'