POST /api_esim/renewCard — Renew a SIM card plan

Renew an active plan for a SIM card. You can identify the card by either its order number or ICCID. The renewal creates a new order linked to the original via mainOrderNum.

POST https://bpm.mioesim.com/api_esim/renewCard

Renewal is only available for plans where flowType=0 (renewable). Check this field in the package list before offering renewal to your customers.

Request parameters

string

required

Session token.

string

required

Product SKU ID.

string

required

Package price ID for the renewal plan.

string

required

Request signature.

string

Order number. Required if iccid is not provided.

string

ICCID of the card to renew. Required if orderNum is not provided.

string

Days to order for DayPass packages (supportDaypass=1).

string

0/empty = order number; 1 = full details; 2 = PDF URL info.

string

PDF language code. See PDF Languages.

string

Your external order ID.

string

Your external line item ID.

string

Optional notes.

Response

Same structure as Place Order with backInfo=1. The renewal field is true and mainOrderNum contains the original order number.

Example

curl -X POST https://bpm.mioesim.com/api_esim/renewCard \
  -d "token=YOUR_TOKEN" \
  -d "iccid=934801019851134300" \
  -d "skuId=45" \
  -d "priceId=441" \
  -d "backInfo=1" \
  -d "sign=YOUR_SIGN"

{
  "code": "0",
  "message": "success",
  "data": {
    "orderNum": "EP20240124000014",
    "display": "Australia",
    "status": 0,
    "renewal": true,
    "mainOrderNum": "EP20240124000013",
    "renew": 1,
    "cardApiDtoList": [
      {
        "iccid": "162984356292255940",
        "data": "6GB",
        "validity": 8,
        "code": "LPA:1$ais.prod.ondemandconnectivity.com$SEW7JEBMFGPRVSPD"
      }
    ]
  }
}

Authentication

eSIM Products

Orders

Physical SIM

ICCID & Cards

Account

By API Code

POST /api_esim/renewCard — Renew a SIM card plan

Request parameters

Response

Example

​Request parameters

​Response

​Example

Request parameters

Response

Example