Skip to content

Apply or remove mobile plan

Request

Applies or removes the organization's mobile plan from an eSIM. When applying, an eSIM can be auto-selected if ICCID is not provided.

Security
ApiKeyAuth
Bodyapplication/jsonrequired
applybooleanrequired

true to apply the mobile plan, false to remove it

Example:true
labelstringrequired

eSIM label to target

Example:"Green"
iccidstring

Target eSIM ICCID (optional - auto-selected if omitted when apply=true)

Example:"8948010010036795085"
POST
/v3/wallet/mobile-plan
curl -i -X POST \
  'https://api.tellisim.com/v3/wallet/mobile-plan?key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "apply": true,
    "label": "Green",
    "iccid": "8948010010036795085"
  }'

Responses

Successful response containing mobile plan status

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred

Example:false
dataobjectrequired
Response
{ "error": false, "data": { "iccid": "8948010010036795085", "mobile_plan_applied": true, "id": 3 } }