Table of contents
Overview
This guide describes the SimpleSIM REST API endpoints available to technical clients. You can generate your keys from My Account → API after we have enabled API access on your profile.
Base url
https://simplesim.fr/wp-json/simplesim/v1
Postman
Authentication
HTTP Basic Auth (CK/CS)
Rate limits
10 req/sec • 10,000/day
Content type
application/json; charset=UTF-8
Catalog
| Query param | Type | Required | Default | Description |
|---|---|---|---|---|
per_page |
integer | No | 10 | Number of items per page (1–100) |
page |
integer | No | 1 | Page number |
search |
string | No | Full-text search (also matches product ID if numeric) |
Curl:
CopyCopied !
curl -s -u "ck_key:cs_key" "https://simplesim.fr/wp-json/simplesim/v1/catalog?per_page=10&page=1&search=France"Example payload (JSON):
CopyCopied !
{
"per_page": 10,
"page": 1,
"search": "France"
}Example response (JSON):
CopyCopied !
{
"success": true,
"obj": {
"productsList": [
{
"product_id": 7918,
"slug": "esim-1gb-europe",
"name": "eSIM 1GB, Europe",
"price": 4.99,
"currency": "USD",
"data": "1",
"duration": 30,
"duration_unit": "DAY",
"coverage": "AT,BE,BG,HR,CY,CZ,DK,EE,FI,FR,DE,GI,GR,GG,HU,IS,IE,IT,JE,LV,LI,LT,LU,MT,NL,MK,NO,PL,PT,RO,RU,RS,SK,SI,ES,SE,CH,TR,UA,GB",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-1gb-europe/"
},
{
"product_id": 605,
"slug": "esim-1gb-france",
"name": "eSIM 1GB, France",
"price": 4.99,
"currency": "USD",
"data": "1",
"duration": 7,
"duration_unit": "DAY",
"coverage": "FR",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-1gb-france/"
},
{
"product_id": 23214,
"slug": "esim-unlimited-france",
"name": "eSIM unlimited, France",
"price": 4.99,
"currency": "USD",
"data": null,
"duration": null,
"duration_unit": "DAY",
"coverage": "FR",
"is_unlimited": true,
"unlimited_days_price": {
"1": "3.99",
"2": "6.99",
"3": "9.99",
"4": "11.99",
"5": "14.99",
"6": "17.99",
"7": "19.99",
"8": "22.99",
"9": "25.99",
"10": "28.99",
"11": "31.99",
"12": "34.99",
"13": "37.99",
"14": "39.99",
"15": "41.99",
"16": "42.99",
"17": "44.99",
"18": "45.99",
"19": "47.99",
"20": "48.99",
"21": "49.99",
"22": "50.99",
"23": "51.99",
"24": "52.99",
"25": "53.99",
"26": "54.99",
"27": "55.99",
"28": "56.99",
"29": "57.99",
"30": "59.99",
"31": "60.99",
"32": "61.99",
"33": "62.99",
"34": "63.99",
"35": "64.99",
"36": "65.99",
"37": "66.99",
"38": "67.99",
"39": "68.99",
"40": "69.99",
"41": "70.99",
"42": "71.99",
"43": "72.99",
"44": "73.99",
"45": "74.99",
"46": "75.99",
"47": "76.99",
"48": "77.99",
"49": "78.99",
"50": "79.99",
"51": "80.99",
"52": "81.99",
"53": "82.99",
"54": "83.99",
"55": "84.99",
"56": "85.99",
"57": "86.99",
"58": "87.99",
"59": "88.99",
"60": "89.99"
},
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-unlimited-france/"
},
{
"product_id": 25326,
"slug": "esim-unlimited-europe",
"name": "eSIM unlimited, Europe",
"price": 5.99,
"currency": "USD",
"data": null,
"duration": null,
"duration_unit": "DAY",
"coverage": "AT,BE,BG,HR,CY,CZ,DK,EE,EU,FI,FR,DE,GR,HU,IS,IE,IT,LV,LI,LT,LU,MT,NL,NO,PL,PT,RO,SK,SI,ES,SE,CH,TR,UA,GB",
"is_unlimited": true,
"unlimited_days_price": {
"1": "4.99",
"2": "7.99",
"3": "10.99",
"4": "12.99",
"5": "16.99",
"6": "19.99",
"7": "21.99",
"8": "25.99",
"9": "28.99",
"10": "31.99",
"11": "34.99",
"12": "37.99",
"13": "41.99",
"14": "43.99",
"15": "45.99",
"16": "47.99",
"17": "49.99",
"18": "51.99",
"19": "53.99",
"20": "55.99",
"21": "57.99",
"22": "58.99",
"23": "60.99",
"24": "61.99",
"25": "63.99",
"26": "64.99",
"27": "66.99",
"28": "68.99",
"29": "69.99",
"30": "71.99",
"31": "73.99",
"32": "75.99",
"33": "76.99",
"34": "78.99",
"35": "79.99",
"36": "81.99",
"37": "82.99",
"38": "84.99",
"39": "86.99",
"40": "87.99",
"41": "89.99",
"42": "90.99",
"43": "92.99",
"44": "93.99",
"45": "95.99",
"46": "97.99",
"47": "98.99",
"48": "100.99",
"49": "101.99",
"50": "103.99",
"51": "104.99",
"52": "106.99",
"53": "108.99",
"54": "109.99",
"55": "111.99",
"56": "112.99",
"57": "114.99",
"58": "115.99",
"59": "117.99",
"60": "118.99"
},
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-unlimited-europe/"
},
{
"product_id": 2297,
"slug": "esim-1gb-worldwide",
"name": "eSIM 1GB, worldwide",
"price": 10.99,
"currency": "USD",
"data": "1",
"duration": 7,
"duration_unit": "DAY",
"coverage": "AL,AR,AM,AU,AT,AZ,BE,BO,BA,BW,BR,BG,CM,CA,CF,TD,CL,CN,CO,CR,CI,HR,CY,CZ,DK,CD,EC,EG,SV,EE,SZ,FI,FR,GA,DE,GH,GI,GR,GU,GT,GW,HN,HK,HU,IS,IN,ID,IE,IL,IT,JP,JO,KZ,KE,XK,KW,KG,LV,LR,LI,LT,LU,MO,MG,MW,MY,ML,MT,MU,MX,MD,MC,ME,MA,NL,NZ,NI,NE,NG,MK,NO,OM,PK,PA,PY,PE,PH,PL,PT,PR,QA,CG,RO,RU,SA,SN,RS,SC,SG,SK,SI,ZA,KR,ES,LK,SE,CH,TW,TZ,TH,TN,TR,UG,UA,AE,GB,US,UY,UZ,VU,ZM",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-1gb-worldwide/"
},
{
"product_id": 606,
"slug": "esim-5gb-france",
"name": "eSIM 5GB, France",
"price": 10.99,
"currency": "USD",
"data": "5",
"duration": 30,
"duration_unit": "DAY",
"coverage": "FR",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 5,
"link": "https://simplesim.fr/product/esim-5gb-france/"
},
{
"product_id": 6725,
"slug": "esim-10gb-france",
"name": "eSIM 10GB, France",
"price": 18.99,
"currency": "USD",
"data": "10",
"duration": 30,
"duration_unit": "DAY",
"coverage": "FR",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 5,
"link": "https://simplesim.fr/product/esim-10gb-france/"
},
{
"product_id": 8482,
"slug": "esim-10gb-europe",
"name": "eSIM 10GB, Europe",
"price": 21.99,
"currency": "USD",
"data": "10",
"duration": 30,
"duration_unit": "DAY",
"coverage": "AT,BE,BG,HR,CY,CZ,DK,EE,FI,FR,DE,GR,HU,IS,IE,IT,LV,LI,LT,LU,MT,NL,NO,PL,PT,RO,SK,SI,ES,SE,CH,TR,UA,GB",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-10gb-europe/"
},
{
"product_id": 4385,
"slug": "esim-3gb-worldwide",
"name": "eSIM 3GB, worldwide",
"price": 21.99,
"currency": "USD",
"data": "3",
"duration": 30,
"duration_unit": "DAY",
"coverage": "AL,AR,AM,AU,AT,AZ,BE,BO,BA,BW,BR,BG,CM,CA,CF,TD,CL,CN,CO,CR,CI,HR,CY,CZ,DK,CD,EC,EG,SV,EE,SZ,FI,FR,GA,DE,GH,GI,GR,GU,GT,GW,HN,HK,HU,IS,IN,ID,IE,IL,IT,JP,JO,KZ,KE,XK,KW,KG,LV,LR,LI,LT,LU,MO,MG,MW,MY,ML,MT,MU,MX,MD,MC,ME,MA,NL,NZ,NI,NE,NG,MK,NO,OM,PK,PA,PY,PE,PH,PL,PT,PR,QA,CG,RO,RU,SA,SN,RS,SC,SG,SK,SI,ZA,KR,ES,LK,SE,CH,TW,TZ,TH,TN,TR,UG,UA,AE,GB,US,UY,UZ,VU,ZM",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-3gb-worldwide/"
},
{
"product_id": 26532,
"slug": "esim-20gb-france",
"name": "eSIM 20GB, France",
"price": 27.99,
"currency": "USD",
"data": "20",
"duration": 30,
"duration_unit": "DAY",
"coverage": "FR",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-20gb-france/"
}
],
"page": 1,
"per_page": 10,
"total": 15,
"total_pages": 2
},
"errorCode": null,
"errorMsg": null
}Product
| Query param | Type | Required | Default | Description |
|---|---|---|---|---|
product_id |
integer | Yes | Product ID |
Curl:
CopyCopied !
curl -s -u "ck_key:cs_key" "https://simplesim.fr/wp-json/simplesim/v1/catalog/7918"Example response (JSON):
CopyCopied !
{
"success": true,
"obj": {
"product": {
"product_id": 7918,
"slug": "esim-1gb-europe",
"name": "eSIM 1GB, Europe",
"price": 4.99,
"currency": "USD",
"data": "1",
"duration": 30,
"duration_unit": "DAY",
"coverage": "AT,BE,BG,HR,CY,CZ,DK,EE,FI,FR,DE,GI,GR,GG,HU,IS,IE,IT,JE,LV,LI,LT,LU,MT,NL,MK,NO,PL,PT,RO,RU,RS,SK,SI,ES,SE,CH,TR,UA,GB",
"is_unlimited": false,
"unlimited_days_price": null,
"topup_max_boosts": 0,
"link": "https://simplesim.fr/product/esim-1gb-europe/"
}
},
"errorCode": null,
"errorMsg": null
}Compatible devices
| Query param | Type | Required | Default | Description |
|---|---|---|---|---|
per_page |
integer | No | 10 | Number of items per page (1–100) |
page |
integer | No | 1 | Page number |
search |
string | No | Search model |
Curl:
CopyCopied !
curl -s -u "ck_key:cs_key" "https://simplesim.fr/wp-json/simplesim/v1/compatible-devices?per_page=3&page=1&search=iphone"Example payload (JSON):
CopyCopied !
{
"per_page": 3,
"page": 1,
"search": "iphone"
}Example response (JSON):
CopyCopied !
{
"success": true,
"obj": {
"devicesList": [
{
"Name": "Apple iPhone 17",
"manufacturer": "Apple",
"model": "iPhone 17",
"release_year": 2025,
"comments": "Nano-SIM + eSIM + eSIM (max 2 at a time; International)\neSIM + eSIM (8 or more, max 2 at a time; USA)\nNano-SIM + Nano-SIM (China)"
},
{
"Name": "Apple iPhone Air",
"manufacturer": "Apple",
"model": "iPhone Air",
"release_year": 2025,
"comments": "eSIM + eSIM (8 or more, max 2 at a time)"
},
{
"Name": "Apple iPhone 17 Pro",
"manufacturer": "Apple",
"model": "iPhone 17 Pro",
"release_year": 2025,
"comments": "Nano-SIM + eSIM + eSIM (max 2 at a time; International)\neSIM + eSIM (8 or more, max 2 at a time; USA)\nNano-SIM + Nano-SIM (China)"
}
],
"page": 1,
"per_page": 3,
"total": 33,
"total_pages": 11
},
"errorCode": null,
"errorMsg": null
}New order
| Query param | Type | Required | Default | Description |
|---|---|---|---|---|
products |
array | No | Array of products | |
products[].product_id |
integer | Yes | Product ID | |
products[].quantity |
integer | No | 1 | Quantity (>=1) |
products[].coverage |
string | No | Two-letter coverage code (e.g., FR, US). Use this if the product is multi-destination and you want your client to see a specific flag | |
products[].unlimited_days |
integer | No | Number of unlimited days (unlimited products only) | |
products[].topup_boosts |
integer | No | Number of boosts (if available) | |
products[].topup_sku |
string | No | Topup SKU | |
products[].topup_esim_id |
integer | No | Target eSIM ID for topup | |
note |
string | No | Internal reference, customer informations... Anything you need. Visible in API order detail and in your account | |
send_processing_email |
boolean | No | false | Send the order confirmation email |
send_completed_email |
boolean | No | false | Send the order completed email (containing esims) |
end_client_email |
string | No | End-client email | |
send_end_client_email |
boolean | No | false | Send the completed email to end-client |
testing |
boolean | No | false | If true, returns a mock payload identical to the documentation example (other parameters will be ignored) |
Curl:
CopyCopied !
curl -s -u "ck_key:cs_key" -H "Content-Type: application/json" -X POST 'https://simplesim.fr/wp-json/simplesim/v1/orders' -d '{"products":[{"product_id":1234,"quantity":1,"coverage":"fr","unlimited_days":0,"topup_boosts":0,"topup_sku":null,"topup_esim_id":null}],"note":"Your order note","send_processing_email":true,"send_completed_email":false,"end_client_email":"client@example.com","send_end_client_email":true}'Example payload (JSON):
CopyCopied !
{
"products": [
{
"product_id": 1234,
"quantity": 1,
"coverage": "fr",
"unlimited_days": 0,
"topup_boosts": 0,
"topup_sku": null,
"topup_esim_id": null
}
],
"note": "Your order note",
"send_processing_email": true,
"send_completed_email": false,
"end_client_email": "client@example.com",
"send_end_client_email": true
}Example response (JSON):
CopyCopied !
{
"success": true,
"obj": {
"order": {
"id": 0,
"status": "completed",
"created_at": "2026-02-11T17:49:18+00:00",
"currency": "EUR",
"note": "Your order note",
"products": [
{
"product_id": 0,
"name": "eSIM 30GB, Dummy",
"quantity": 1,
"unit_price": 39.99,
"line_total": 39.99,
"line_discount": 0
}
],
"esims": [
{
"id": 101,
"order_id": 0,
"product_id": 0,
"status": "in_use",
"ac": "LPA:1$smdpplusaddress.com$0123456789ABCDEF0123456789ABCDEF",
"msisdn": "000000000000",
"pin": "0000",
"apn_name": "apn",
"apn_user": "apnUser",
"apn_password": "apnPassword",
"note": "Some extra informations about the esim"
}
],
"esims_count": 1,
"totals": {
"subtotal": 39.99,
"discount": 0,
"fees": [
{
"label": "Commission",
"total": -4
}
],
"fees_total": 0,
"total": 36,
"currency": "EUR"
}
}
},
"errorCode": null,
"errorMsg": null
}Orders list
| Query param | Type | Required | Default | Description |
|---|---|---|---|---|
per_page |
integer | No | 10 | Number of items per page (1–100) |
page |
integer | No | 1 | Page number |
date_from |
string | No | Created on/after (UTC). Format: YYYY-MM-DD | |
date_to |
string | No | Created on/before (UTC). Format: YYYY-MM-DD | |
testing |
boolean | No | false | If true, returns a mock payload identical to the documentation example (Other parameters will be ignored) |
Curl:
CopyCopied !
curl -s -u "ck_key:cs_key" "https://simplesim.fr/wp-json/simplesim/v1/orders?per_page=10&page=1&date_from=2026-02-10&date_to=2026-02-11"Example payload (JSON):
CopyCopied !
{
"per_page": 10,
"page": 1,
"date_from": "2026-02-10",
"date_to": "2026-02-11"
}Example response (JSON):
CopyCopied !
{
"success": true,
"obj": {
"orders": [
{
"id": 8002,
"status": "completed",
"created_at": "2026-02-11T15:49:18+00:00",
"currency": "EUR",
"note": "The note added when you ordered",
"items": [
{
"sku": "ESIM-DUMMY-30G-30D",
"name": "eSIM 30GB, Dummy",
"quantity": 2,
"unit_price_ex_tax": 7,
"unit_price_inc_tax": 9,
"line_total_ex_tax": 15,
"line_total_inc_tax": 18,
"line_discount_ex_tax": 0,
"line_discount_inc_tax": 0
}
],
"esims": [
{
"id": 202,
"order_id": 8002,
"product_id": 0,
"status": "in_use",
"ac": "LPA:1$smdpplusaddress.com$0123456789ABCDEF0123456789ABCDEF",
"msisdn": "000000000000",
"pin": "0000",
"apn_name": "apn",
"apn_user": "apnUser",
"apn_password": "apnPassword",
"note": "Some extra informations about the esim"
},
{
"id": 203,
"order_id": 8002,
"product_id": 0,
"status": "in_use",
"ac": "LPA:1$smdpplusaddress.com$0123456789ABCDEF0123456789ABCDEF",
"msisdn": "000000000001",
"pin": "0000",
"apn_name": "apn",
"apn_user": "apnUser",
"apn_password": "apnPassword",
"note": "Some extra informations about the esim"
}
],
"esims_count": 2,
"totals": {
"subtotal_ex_tax": 15,
"subtotal_inc_tax": 18,
"tax_total": 3,
"discount_ex_tax": 0,
"discount_tax": 0,
"discount_inc_tax": 0,
"fees": [
{
"label": "Commission",
"total_ex_tax": -3.33,
"total_tax": -0.67,
"total_inc_tax": -4
}
],
"fees_total_inc_tax": -4,
"total_ex_tax": 15,
"total_inc_tax": 14,
"currency": "EUR"
}
}
],
"page": 1,
"per_page": 10,
"total": 42,
"total_pages": 5
},
"errorCode": null,
"errorMsg": null
}Order detail
| Path param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | Yes | Order ID (use id=0 to get the example payload) |
Curl:
CopyCopied !
curl -s -u "ck_key:cs_key" "https://simplesim.fr/wp-json/simplesim/v1/orders/0"Example response (JSON):
CopyCopied !
{
"success": true,
"obj": {
"order": {
"id": 0,
"status": "completed",
"created_at": "2026-02-11T15:49:18+00:00",
"currency": "EUR",
"note": "The note added when you ordered",
"items": [
{
"sku": "ESIM-DUMMY-30G-30D",
"name": "eSIM 30GB, Dummy",
"quantity": 2,
"unit_price_ex_tax": 7,
"unit_price_inc_tax": 9,
"line_total_ex_tax": 15,
"line_total_inc_tax": 18,
"line_discount_ex_tax": 0,
"line_discount_inc_tax": 0
}
],
"esims": [
{
"id": 202,
"order_id": 8002,
"product_id": 0,
"status": "in_use",
"ac": "LPA:1$smdpplusaddress.com$0123456789ABCDEF0123456789ABCDEF",
"msisdn": "000000000000",
"pin": "0000",
"apn_name": "apn",
"apn_user": "apnUser",
"apn_password": "apnPassword",
"note": "Some extra informations about the esim"
},
{
"id": 203,
"order_id": 8002,
"product_id": 0,
"status": "in_use",
"ac": "LPA:1$smdpplusaddress.com$0123456789ABCDEF0123456789ABCDEF",
"msisdn": "000000000001",
"pin": "0000",
"apn_name": "apn",
"apn_user": "apnUser",
"apn_password": "apnPassword",
"note": "Some extra informations about the esim"
}
],
"esims_count": 2,
"totals": {
"subtotal_ex_tax": 15,
"subtotal_inc_tax": 18,
"tax_total": 3,
"discount_ex_tax": 0,
"discount_tax": 0,
"discount_inc_tax": 0,
"fees": [
{
"label": "Commission",
"total_ex_tax": -3.33,
"total_tax": -0.67,
"total_inc_tax": -4
}
],
"fees_total_inc_tax": -4,
"total_ex_tax": 15,
"total_inc_tax": 14,
"currency": "EUR"
}
}
},
"errorCode": null,
"errorMsg": null
}eSIMs list
| Query param | Type | Required | Default | Description |
|---|---|---|---|---|
per_page |
integer | No | 10 | Number of items per page (1-100) |
page |
integer | No | 1 | Page number |
status |
string | No | Filter by status. Status is usually known but can stay unknown on certain destinations (Possible status: null,"not_used","in_use","used_up") | |
date_from |
string | No | Filter by date. Created on/after this date. Format: YYYY-MM-DD | |
date_to |
string | No | Filter by date. Created on/before this date. Format: YYYY-MM-DD | |
testing |
boolean | No | false | If true, returns a mock payload identical to the documentation example (other parameters will be ignored). |
Curl:
CopyCopied !
curl -s -u "ck_key:cs_key" "https://simplesim.fr/wp-json/simplesim/v1/esims?per_page=10&page=1&status=in_use&date_from=2026-02-10&date_to=2026-02-11"Example payload (JSON):
CopyCopied !
{
"per_page": 10,
"page": 1,
"status": "in_use",
"date_from": "2026-02-10",
"date_to": "2026-02-11"
}Example response (JSON):
CopyCopied !
{
"success": true,
"obj": {
"esims": [
{
"id": 101,
"order_id": 9001,
"product_id": 0,
"status": "in_use",
"ac": "LPA:1$smdpplusaddress.com$0123456789ABCDEF0123456789ABCDEF",
"msisdn": "000000000001",
"pin": "0000",
"apn_name": "apn",
"apn_user": "apnUser",
"apn_password": "apnPassword",
"note": "Some extra informations about the esim"
},
{
"id": 102,
"order_id": 9002,
"product_id": 0,
"status": "used_up",
"ac": "LPA:1$smdpplusaddress.com$0123456789ABCDEF0123456789ABCDEF",
"msisdn": "000000000002",
"pin": "0000",
"apn_name": "apn",
"apn_user": "apnUser",
"apn_password": "apnPassword",
"note": "Some extra informations about the esim"
}
],
"page": 1,
"per_page": 10,
"total": 42,
"total_pages": 5
},
"errorCode": null,
"errorMsg": null
}eSIM detail
| Query param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | Yes | eSIM post ID (numeric). Use id=0 for testing |
Curl:
CopyCopied !
curl -s -u "ck_key:cs_key" "https://simplesim.fr/wp-json/simplesim/v1/esims/0"Example response (JSON):
CopyCopied !
{
"success": true,
"obj": {
"esim": {
"id": 0,
"order_id": 0,
"product_id": 0,
"status": "in_use",
"ac": "LPA:1$smdpplusaddress.com$0123456789ABCDEF0123456789ABCDEF",
"msisdn": "000000000000",
"pin": "0000",
"apn_name": "apn",
"apn_user": "apnUser",
"apn_password": "apnPassword",
"note": "Some extra informations about the esim",
"activation_time": "2026-02-11T17:49:18+00:00",
"duration": 30,
"available_topups": [
101,
102
],
"data_percentage_used": 12.5,
"is_unlimited": false,
"links": {
"url": "https://simplesim.fr/esim/esim-1234?ac=YWJjMTIz",
"png": "https://simplesim.fr/esim/esim-1234?ac=YWJjMTIz&format=png",
"pdf": "https://simplesim.fr/esim/esim-1234?ac=YWJjMTIz&format=pdf"
}
}
},
"errorCode": null,
"errorMsg": null
}