← Scalar reference

Examples for every endpoint

Set API_ORIGIN, SUBSCRIBER_ACCESS_TOKEN and the path variables listed in each program. Edit illustrative request bodies or use REQUEST_BODY_FILE. Optional QUERY_JSON sets the documented query filters. CSV transfers use RECIPIENT_EMAIL and CSV_FILE.

JavaScript: node FILE.mjs · Python: python3 FILE.py · Ruby: ruby FILE.rb. Rust: place Cargo.toml and Cargo.lock in a project with downloaded Rust files under src/bin, then run cargo run --locked --bin NAME.

Programs make one real request to your chosen host. They do not automatically retry. Read the manual before purchases or carrier actions.

EndpointJavaScriptPythonRustRuby
List available plans
GET /subscriber/plan
JavaScriptPythonRustRuby
Get a plan
GET /subscriber/plan/{planId}
JavaScriptPythonRustRuby
List plan prices and durations
GET /subscriber/plan_pricing
JavaScriptPythonRustRuby
Get a plan price
GET /subscriber/plan_pricing/{planPricingId}
JavaScriptPythonRustRuby
List your SIMs
GET /subscriber/sim
JavaScriptPythonRustRuby
Search SIMs using JSON filters
POST /subscriber/sim
JavaScriptPythonRustRuby
List recovery records
GET /subscriber/sim/recovery
JavaScriptPythonRustRuby
List outgoing transfers
GET /subscriber/sim/transfer/out
JavaScriptPythonRustRuby
List incoming transfers
GET /subscriber/sim/transfer/in
JavaScriptPythonRustRuby
Send SIM transfer requests by CSV
POST /subscriber/sim/bulk/transfer
JavaScriptPythonRustRuby
Accept, reject or cancel transfers
PATCH /subscriber/sim/transfer
JavaScriptPythonRustRuby
Get your SIM details
GET /subscriber/sim/{simId}
JavaScriptPythonRustRuby
List add-on activations on a SIM
GET /subscriber/sim/{simId}/add-on_plan_activations
JavaScriptPythonRustRuby
Purchase SIMs with plans
POST /subscriber/sim/purchase
JavaScriptPythonRustRuby
Quote SIM and plan purchase
POST /subscriber/sim/purchase/price
JavaScriptPythonRustRuby
Quote SIM cards without a plan purchase
POST /subscriber/sim/purchase/sim/price
JavaScriptPythonRustRuby
Assign a SIM by phone number
POST /subscriber/sim/{mdn}/assign
JavaScriptPythonRustRuby
Assign a SIM by ESN
POST /subscriber/sim/esn/{esn}/assign
JavaScriptPythonRustRuby
Assign multiple SIMs
POST /subscriber/sim/assign
JavaScriptPythonRustRuby
Activate a SIM with a plan
POST /subscriber/sim/{simId}/activate
JavaScriptPythonRustRuby
Retry activation of a paid SIM
POST /subscriber/sim/{simId}/reactivate
JavaScriptPythonRustRuby
Reconnect a disconnected SIM
POST /subscriber/sim/{simId}/reconnect
JavaScriptPythonRustRuby
Purchase add-ons directly for a SIM
POST /subscriber/sim/{mdnOrEsn}/addons/purchase
JavaScriptPythonRustRuby
Quote renewal, plan change or reconnect
POST /subscriber/sim/price
JavaScriptPythonRustRuby
Submit bulk renewals
POST /subscriber/sim/bulk/renew
JavaScriptPythonRustRuby
Quote bulk renewals
POST /subscriber/sim/bulk/renew/price
JavaScriptPythonRustRuby
Submit bulk refreshes
POST /subscriber/sim/bulk/refresh
JavaScriptPythonRustRuby
Quote bulk refreshes
POST /subscriber/sim/bulk/refresh/price
JavaScriptPythonRustRuby
Refresh a SIM number or card
POST /subscriber/sim/{simId}/refresh
JavaScriptPythonRustRuby
Activate a replacement refresh SIM
POST /subscriber/sim/{simId}/refresh/esn/activate
JavaScriptPythonRustRuby
Quote a SIM refresh
POST /subscriber/sim/{simId}/refresh/price
JavaScriptPythonRustRuby
Check recovery eligibility
GET /subscriber/sim/check_recoverability/{simId}
JavaScriptPythonRustRuby
Purchase SIM recovery
POST /subscriber/sim/{simId}/recovery/purchase
JavaScriptPythonRustRuby
Quote SIM recovery
POST /subscriber/sim/{simId}/recovery/purchase/price
JavaScriptPythonRustRuby
Recover using an existing owned SIM
POST /subscriber/sim/{simId}/recovery/esn
JavaScriptPythonRustRuby
Activate the replacement recovery SIM
POST /subscriber/sim/{simId}/recovery/esn/activate
JavaScriptPythonRustRuby
Retry an eligible recovery record
POST /subscriber/sim/recovery/retry
JavaScriptPythonRustRuby
Check SIM status with a device IMEI
POST /subscriber/sim/{simId}/check-sim-status
JavaScriptPythonRustRuby
Check bulk action eligibility
POST /subscriber/sim/bulk/check/eligibility
JavaScriptPythonRustRuby
Quote a bulk action
POST /subscriber/sim/bulk/price
JavaScriptPythonRustRuby
Purchase a bulk action
POST /subscriber/sim/bulk/purchase
JavaScriptPythonRustRuby
Find eligible pricing for bulk actions
POST /subscriber/sim/bulk/plan_pricings
JavaScriptPythonRustRuby
Get the SIM current plan
GET /subscriber/sim/{simId}/plan
JavaScriptPythonRustRuby
Enable automatic renewal
POST /subscriber/sim/{simId}/plan/auto_renew/enable
JavaScriptPythonRustRuby
Disable automatic renewal
POST /subscriber/sim/{simId}/plan/auto_renew/disable
JavaScriptPythonRustRuby
Enable automatic add-on extension
POST /subscriber/sim/{simId}/plan/auto_extend/enable
JavaScriptPythonRustRuby
Disable automatic add-on extension
POST /subscriber/sim/{simId}/plan/auto_extend/disable
JavaScriptPythonRustRuby
Renew a SIM plan
POST /subscriber/sim/{simId}/plan/renew
JavaScriptPythonRustRuby
Change a SIM plan
POST /subscriber/sim/{simId}/plan/change
JavaScriptPythonRustRuby
List your purchased add-ons
GET /subscriber/add-on_plans
JavaScriptPythonRustRuby
Get a purchased add-on
GET /subscriber/add-on_plans/{subscriberAddOnPlanId}
JavaScriptPythonRustRuby
Purchase add-ons for your account
POST /subscriber/add-on_plans/purchase
JavaScriptPythonRustRuby
Quote an add-on purchase
POST /subscriber/add-on_plans/purchase/price
JavaScriptPythonRustRuby
Quote changing an owned add-on
POST /subscriber/add-on_plans/change/price
JavaScriptPythonRustRuby
Change an owned add-on
POST /subscriber/add-on_plans/change
JavaScriptPythonRustRuby
Activate an owned add-on on a SIM
POST /subscriber/add-on_plans/activate
JavaScriptPythonRustRuby
Purchase a replacement SIM
POST /subscriber/sim/{simId}/reorder/purchase
JavaScriptPythonRustRuby
Quote a replacement SIM
POST /subscriber/sim/{simId}/reorder/purchase/price
JavaScriptPythonRustRuby
Purchase a physical SIM or eSIM switch
POST /subscriber/sim/{simId}/sim_source/change/purchase
JavaScriptPythonRustRuby
Quote a physical SIM or eSIM switch
POST /subscriber/sim/{simId}/sim_source/change/purchase/price
JavaScriptPythonRustRuby