# Subscriber SIMs, plans and add-ons

Manage your SIM purchases, activation, renewal, recovery and account-to-account transfers. Browse plans and pricing, buy or activate add-ons, and perform eligible bulk actions.

## Connect to your account

Ask your operator for the API origin and sign in through its subscriber application. Use your **subscriber session access token** in `Authorization: Bearer TOKEN`. In Scalar, select **SubscriberSession** and enter the token alone. When these docs are served by the API, the server is selected from the current operator host, for example `https://your-operator.api.lifeline.mobi`.

```sh
export API_ORIGIN='https://your-operator.api.lifeline.mobi'
export SUBSCRIBER_ACCESS_TOKEN='REPLACE_WITH_YOUR_SUBSCRIBER_SESSION_TOKEN'
curl "$API_ORIGIN/subscriber/plan" \
  --header "Authorization: Bearer $SUBSCRIBER_ACCESS_TOKEN"
```

The example host is a placeholder. Replace `your-operator` with the operator subdomain before running downloaded examples. Requests go directly to your chosen server. Authorization is not saved across reloads. UUIDs, ESNs, phone numbers, addresses and amounts in examples are illustrative.

These routes use camelCase fields and subscriber session authentication. The separate `/subscriber/external/v1` API and its `sub_` tokens, scopes, idempotency keys and operation-polling contract do not apply here.

## Run examples in your language

Every endpoint has complete JavaScript, Python, Rust and Ruby programs in the Scalar code panel, alongside cURL. Open **Download examples** at the top of this page to save the files.

| Language | Requirements | Run a downloaded example |
| --- | --- | --- |
| JavaScript | Node.js 20+, built-in fetch | `node plan_getAll.mjs` |
| Python | Python 3.9+, standard library | `python3 plan_getAll.py` |
| Rust | Stable Rust and Cargo; supplied Cargo.toml and Cargo.lock | `cargo run --locked --bin plan_getAll` from the Rust project directory |
| Ruby | Ruby 2.6+, standard library | `ruby plan_getAll.rb` |

Set `API_ORIGIN` and `SUBSCRIBER_ACCESS_TOKEN` as above. Each program lists any additional required variables, such as `SIM_ID` or `PLAN_PRICING_ID`, at the top. Keep identifiers as strings. For Rust, place downloaded `.rs` files under `src/bin/` beside the supplied Cargo.toml and Cargo.lock; Cargo downloads dependencies on its first run.

For JSON requests, edit the illustrative body in the program or set `REQUEST_BODY_FILE` to a UTF-8 JSON file containing your complete request. For endpoints with query parameters, optionally set `QUERY_JSON` to a JSON object of the documented filters, for example `{"page":1,"limit":10}` where pagination is supported. Arrays are sent as comma-separated query values. CSV transfer examples read `RECIPIENT_EMAIL` and `CSV_FILE` and construct multipart form data automatically.

```sh
export SIM_ID='YOUR_SIM_UUID'
export REQUEST_BODY_FILE='/absolute/path/to/request.json'
node sim_plan_sim_renewPlan.mjs
```

Only set `REQUEST_BODY_FILE` for a program accepting a JSON body. Remove or change it before running a different endpoint. The programs print HTTP status and JSON or plain text, handle empty responses, and exit unsuccessfully on non-2xx responses. They use a 30-second timeout, make one request and do not follow redirects or automatically retry purchases. Requests may change live account state when you use a real operator host and token.

## Choose the right identifier

| Identifier | Meaning | Where to find it |
| --- | --- | --- |
| `planId` | The plan product | `GET /subscriber/plan` |
| `planPricingId` | A price and duration for a plan | `GET /subscriber/plan_pricing?planId=...` |
| `simId` | Your SIM UUID | `GET /subscriber/sim` |
| `esn`, `simEsn`, `newEsn` | Current or replacement card ESN/ICCID | SIM details or the physical card; keep as text |
| `mdn` | SIM phone number | SIM details |
| `addOnPlanId` | Add-on catalog product | Eligible add-on results for the selected SIM/action |
| `subscriberAddOnPlanId` | An add-on instance you already own | `GET /subscriber/add-on_plans` |
| `simRecoveryId` | A recovery record | `GET /subscriber/sim/recovery` |
| Transfer IDs | Incoming or outgoing transfer records | `GET /subscriber/sim/transfer/in` or `/out` |
| `shippingRateId` | Available delivery rate | Your operator checkout/shipping selection |
| `activationCode` | Fulfillment activation code | Your operator order/activation workflow |

## Purchase and activate a SIM

1. List available plans, then pricing for your selected plan. Confirm physical SIM or eSIM compatibility and the duration.
2. Call `POST /subscriber/sim/purchase/price` with `planPricingIds` and the same add-ons, device, postal code and delivery details you intend to buy.
3. Review `items`, `subTotal` and `total`. Quotes do not reserve stock or guarantee a later price. Amounts in these quote responses are JSON numbers; use the currency configured by your operator.
4. Call `POST /subscriber/sim/purchase` with the selected details and an enabled `paymentGateway`. Physical delivery requires suitable shipping contact, address and rate information.
5. Follow the returned payment gateway flow. A successful HTTP response can mean payment was initiated; it does not prove a card has shipped or a activation has finished.
6. Refresh your SIMs and check your order in the operator application. For an eligible unassigned card, use the relevant assignment route. For an owned unactivated SIM needing a plan, use `/subscriber/sim/{simId}/activate`.

Card-only pricing is documented for completeness. The matching card-only purchase action is not enabled in this subscriber API.

## Renew or change a plan

Read `GET /subscriber/sim/{simId}/plan`, choose eligible pricing, then quote through `POST /subscriber/sim/price`. Supply one identifier (`simId` or `mdnOrEsn`), the selected `planPricingId`, and the action `type` shown in its schema.

For renewal, submit `POST /subscriber/sim/{simId}/plan/renew`. For a different plan, submit `/plan/change`. Read quote messages and any refund amount before a plan change. Complete payment and re-read the current plan to confirm the new validity or product. Carrier allowance changes depend on the selected product/action; do not assume that every renewal resets usage.

Automatic renewal and automatic add-on extension have separate enable/disable endpoints. Configure the corresponding account payment method through your operator before enabling them. Auto-extend also requires compatible add-ons and thresholds.

## Recover, reconnect or refresh

| Situation | Starting point | Follow-up |
| --- | --- | --- |
| A disconnected subscription | Quote `/subscriber/sim/price` for reconnect | `/subscriber/sim/{simId}/reconnect` |
| Recovery of an eligible original SIM | `GET /subscriber/sim/check_recoverability/{simId}` | Quote `/recovery/purchase/price`, then `/recovery/purchase` |
| Recover onto an eligible active SIM you already own | Check recoverability and target ownership | `/subscriber/sim/{simId}/recovery/esn` with `newEsn` |
| A recovery replacement card has arrived | Obtain its ESN and activation code | `/subscriber/sim/{simId}/recovery/esn/activate` |
| A recovery record needs a supported retry | Read `/subscriber/sim/recovery` | `/subscriber/sim/recovery/retry` with `simRecoveryId` |
| Refresh a number or card | `/subscriber/sim/{simId}/refresh/price` | `/subscriber/sim/{simId}/refresh` |
| A paid order has not activated | Check the existing paid order | `/subscriber/sim/{simId}/reactivate` |

Refresh type `mdn` replaces the phone number and deactivates the old number; type `esn` moves the existing number to a replacement SIM. Recovery, reconnect and refresh have different eligibility checks. Use the result for the selected action and contact your operator if a state is unclear. Recovery onto an existing active target SIM requires the same owner and a compatible provider; pricing may come from that target SIM's current plan.

## Transfer SIM ownership

This transfers SIMs between subscriber accounts. Number porting between carriers is a separate workflow.

1. Prepare a UTF-8 CSV with an `esn` or `iccid` header and at least one SIM row. Preserve identifiers as text. Maximum file size is 15 MiB.
2. Send `POST /subscriber/sim/bulk/transfer` as multipart form data with `file` and the recipient `email`.
3. The sender reviews `/subscriber/sim/transfer/out`; the recipient reviews `/subscriber/sim/transfer/in`.
4. Use `PATCH /subscriber/sim/transfer` to accept, reject or cancel a pending transfer. The allowed role depends on the action.
5. Refresh transfer status and SIM lists to confirm completion.

```csv
esn
89148000001234567890
```

## Buy and use add-ons

For 2–1,000 SIMs, use the bulk eligibility endpoint with the relevant action to discover compatible add-on products. For a single SIM, select compatible products in your operator catalog; the bulk eligibility endpoint requires at least two unique ESNs. `/subscriber/add-on_plans` lists your **purchased instances**, not the general product catalog.

For an account add-on purchase, quote `/subscriber/add-on_plans/purchase/price`, then submit `/purchase` and complete payment. Retrieve the owned `subscriberAddOnPlanId`, then use `/subscriber/add-on_plans/activate` with the target SIM. The add-on must be usable and the SIM must have an eligible active plan. Inspect `/subscriber/sim/{simId}/add-on_plan_activations` afterward.

The SIM-specific `/{mdnOrEsn}/addons/purchase` route is also documented. To change an owned add-on, quote `/subscriber/add-on_plans/change/price`, check `requiresBalanceOnly`, then submit `/change`. The response can be the updated add-on or a payment result depending on the change.

## Work with multiple SIMs

Check `/subscriber/sim/bulk/check/eligibility`, select eligible pricing with `/bulk/plan_pricings` where applicable, quote `/bulk/price`, then submit `/bulk/purchase`. Use the same action and per-SIM selection between quote and purchase. Check every affected SIM after processing.

Dedicated `/bulk/renew` and `/bulk/refresh` workflows are included with their own quote endpoints and request schemas. Their request structures differ from the general bulk-action endpoints; do not interchange their bodies.

## Read results and handle errors

GET and PATCH normally respond with HTTP 200. POST normally responds with HTTP 201 unless the route explicitly overrides it—even price calculations and searches use the POST default. A 2xx status does not establish that payment, fulfillment or processing has completed.

Some routes declare complete response schemas; payment and other service-dependent results have flexible schemas and are labeled accordingly. Do not expect a universal `data` wrapper. The SIM list returns an array without pagination and `{ data, total, page, limit }` with pagination; unavailable filters can return `[]`. Other list endpoints follow their own schemas.

Required request fields are shown in the reference. Shipping, payment-gateway and selected-action conditions can require additional fields even when they are not universally required. Expand nested schemas and read endpoint-specific instructions.

| Status | Next step |
| --- | --- |
| 400 | Correct fields, missing conditional information or unsupported SIM/account state. Read the message and action checks. |
| 401 | Sign in again, check the token and confirm the operator host matches your account. |
| 403 | Check account/operator access or action restrictions with your operator. |
| 404 | Re-read the resource list and use an accessible ID. Check the API origin for a provider-not-found error. |
| 409 | Review the conflict and current resource state before trying again. |
| 429 | Wait before another purchase attempt and check whether an earlier order exists. |
| 500 | Check SIM/order/recovery state and contact support if the outcome is unclear. |

A typical error is `{ "statusCode": 404, "message": "The sim you requested could not be found.", "error": "SIM_NOT_FOUND" }`. Validation and service failures may have different shapes. Use the actual status and body.

These routes do not declare a general idempotency-key contract. After a timeout on a purchase, transfer or SIM action, inspect the existing order/resource or contact support before repeating it. Send support the action, time, relevant SIM/order/recovery ID and error message. Keep access tokens and payment details private.


# Endpoint reference

## Plans and pricing

Browse the plans available to your subscriber account and compare their prices and durations. Start with the plan list, then use its planId to find pricing options. Keep the selected planPricingId for quotes, purchases, activation or renewal. Before paying, use the relevant quote endpoint to calculate any additional charges.

### List available plans

`GET /subscriber/plan`

Browse active public plans and private plans made available to your account. Filter by SIM source or plan category. An unknown category or SIM source returns an empty array. The isActive query does not enable inactive plans: this list always selects active plans.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| isActive | query | No | Is Active. |
| simSourceId | query | No | Sim Source Id. |
| includeEquivalentSimSourceType | query | No | Include Equivalent Sim Source Type. |
| planCategoryName | query | No | Plan Category Name. |
| planCategoryId | query | No | Plan Category Id. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/plan" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/plan_getAll.mjs) · [Python](examples/python/plan_getAll.py) · [Rust](examples/rust/src/bin/plan_getAll.rs) · [Ruby](examples/ruby/plan_getAll.rb)

### Get a plan

`GET /subscriber/plan/{planId}`

Read a plan available to your account. Use its ID to find purchasable durations and prices; a plan ID is different from a plan pricing ID.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `PLAN_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| planId | path | Yes | Plan product ID from the available plan list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/plan/${PLAN_ID}" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/plan_getById.mjs) · [Python](examples/python/plan_getById.py) · [Rust](examples/rust/src/bin/plan_getById.rs) · [Ruby](examples/ruby/plan_getById.rb)

### List plan prices and durations

`GET /subscriber/plan_pricing`

Use planId to find pricing for your chosen plan. includeEquivalentSimSourceType=true broadens a SIM source filter to the same provider. The list always selects active pricing even when isActive=false is supplied. An unavailable plan or SIM source returns an empty array.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| planId | query | No | Plan product ID from the available plan list. |
| simSourceId | query | No | Sim Source Id. |
| includeEquivalentSimSourceType | query | No | Include Equivalent Sim Source Type. |
| isActive | query | No | Is Active. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/plan_pricing" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/planPricing_getAll.mjs) · [Python](examples/python/planPricing_getAll.py) · [Rust](examples/rust/src/bin/planPricing_getAll.rs) · [Ruby](examples/ruby/planPricing_getAll.rb)

### Get a plan price

`GET /subscriber/plan_pricing/{planPricingId}`

Read the selected price and duration before quoting or buying. Use this planPricingId in purchase, renewal, activation or plan-change requests.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `PLAN_PRICING_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| planPricingId | path | Yes | Price and duration ID from plan pricing; distinct from planId. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/plan_pricing/${PLAN_PRICING_ID}" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/planPricing_getById.mjs) · [Python](examples/python/planPricing_getById.py) · [Rust](examples/rust/src/bin/planPricing_getById.rs) · [Ruby](examples/ruby/planPricing_getById.rb)

## Your SIMs

Find the SIMs belonging to your account and inspect their phone numbers, ESNs/ICCIDs and current subscription details. Use the GET list for query filters or the POST search for JSON filters, including multiple identifiers. Save the simId for later actions and refresh SIM details after payment or processing to confirm the result.

### List your SIMs

`GET /subscriber/sim`

Find your SIM ID, ESN/ICCID, phone number and current subscription. Supply page and limit for a paginated response; without pagination the response is a plain array. Invalid plan or SIM-source filters can return an empty array even with pagination.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| esn | query | No | ESN/ICCID search terms. Partial, case-insensitive matches are used. Maximum 1000 items. |
| mdn | query | No | MDN/MSISDN search terms. Partial, case-insensitive matches are used. Maximum 1000 items. |
| simSourceId | query | No | Filter by a specific SIM source UUID. |
| includeEquivalentSimSourceType | query | No | When simSourceId is present, include SIM sources with the same provider instead of only the exact source. |
| eligibleForRecovery | query | No | When simSourceId is present, return only active regular SIMs eligible for recovery with the same source provider. |
| planId | query | No | Filter by plan UUID. |
| autoRenew | query | No | Filter by plan subscription auto-renew setting. |
| isActive | query | No | Filter by SIM activation state. |
| simStatus | query | No | Possible values: active, inactive, destroyed |
| simPlanStatus | query | No | Possible values: no_plan, disconnected, not_disconnected, suspended, expired, in_use |
| page | query | No | Page number for pagination. Pagination is applied only when both page and limit are provided. |
| limit | query | No | Number of SIMs per page. Pagination is applied only when both page and limit are provided. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/sim" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_getAll.mjs) · [Python](examples/python/sim_sim_getAll.py) · [Rust](examples/rust/src/bin/sim_sim_getAll.rs) · [Ruby](examples/ruby/sim_sim_getAll.rb)

### Search SIMs using JSON filters

`POST /subscriber/sim`

The JSON-body alternative to the SIM list supports arrays of ESN and MDN values. This POST performs a search. Supply page and limit for pagination; without pagination it returns an array. Invalid plan or SIM-source filters can return an empty array.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: GetSimsSubscriberDto.

```json
{
  "page": 1,
  "limit": 10
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "page": 1,
  "limit": 10
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_getAllV2.mjs) · [Python](examples/python/sim_sim_getAllV2.py) · [Rust](examples/rust/src/bin/sim_sim_getAllV2.rs) · [Ruby](examples/ruby/sim_sim_getAllV2.rb)

### Get your SIM details

`GET /subscriber/sim/{simId}`

Read one SIM belonging to your account. Keep its ID for later actions and refresh these details after payment or processing. Availability flags and current subscription state determine which actions can proceed.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/sim/${SIM_ID}" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_getById.mjs) · [Python](examples/python/sim_sim_getById.py) · [Rust](examples/rust/src/bin/sim_sim_getById.rs) · [Ruby](examples/ruby/sim_sim_getById.rb)

## SIM purchase

Buy physical SIMs or eSIMs with selected plans. Choose plan pricing, calculate a quote with your intended add-ons and delivery details, then submit the purchase with an enabled payment method. Complete the returned checkout flow and check your order and SIM status afterward. Physical cards require delivery information. The card-only quote is included for reference, but its matching purchase route is not enabled.

### Purchase SIMs with plans

`POST /subscriber/sim/purchase`

Choose one or more planPricingIds and quote the same selection first. Physical delivery needs shipping details and a valid shippingRateId. The response starts the payment flow; complete payment and check your SIMs/orders before treating the purchase as activated. Purchase attempts are limited to 10 per subscriber per 60 seconds.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: PurchaseSimSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "planPricingIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "addOnPlanIds": [],
  "zipCodeActivation": "10001"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/purchase" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "planPricingIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "addOnPlanIds": [],
  "zipCodeActivation": "10001"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_purchase.mjs) · [Python](examples/python/sim_sim_purchase.py) · [Rust](examples/rust/src/bin/sim_sim_purchase.rs) · [Ruby](examples/ruby/sim_sim_purchase.rb)

### Quote SIM and plan purchase

`POST /subscriber/sim/purchase/price`

Quote the same planPricingIds, add-ons, device and delivery details you intend to purchase. Read items, subTotal and total; total includes the applicable calculated charges. A quote does not reserve stock or lock the price.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: CalculatePurchasePriceSubscriberDto.

```json
{
  "planPricingIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "addOnPlanIds": [],
  "zipCodeActivation": "10001"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/purchase/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "planPricingIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "addOnPlanIds": [],
  "zipCodeActivation": "10001"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_calculatePurchasePrice.mjs) · [Python](examples/python/sim_sim_calculatePurchasePrice.py) · [Rust](examples/rust/src/bin/sim_sim_calculatePurchasePrice.rs) · [Ruby](examples/ruby/sim_sim_calculatePurchasePrice.rb)

### Quote SIM cards without a plan purchase

`POST /subscriber/sim/purchase/sim/price`

Calculate a card-only quote using planId and quantity. The separate POST /subscriber/sim/purchase/sim action is not exposed in this subscriber API, so this quote does not have a corresponding enabled card-only purchase endpoint. Use the supported SIM-and-plan purchase workflow.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: CalculatePurchaseSimPriceSubscriberDto.

```json
{
  "planId": "11111111-1111-4111-8111-111111111111",
  "quantity": 1
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/purchase/sim/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "planId": "11111111-1111-4111-8111-111111111111",
  "quantity": 1
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_calculatePurchaseSimPrice.mjs) · [Python](examples/python/sim_sim_calculatePurchaseSimPrice.py) · [Rust](examples/rust/src/bin/sim_sim_calculatePurchaseSimPrice.rs) · [Ruby](examples/ruby/sim_sim_calculatePurchaseSimPrice.rb)

## SIM activation

Assign eligible SIMs to your subscriber account and activate them with compatible plans. Choose assignment by phone number and verification code, by ESN, or by a list of ESNs, depending on the card and its original order. Activation may initiate payment; confirm the resulting SIM state after checkout. An eligible paid order whose activation did not finish can use the reactivation route. A device IMEI check is also available.

### Assign a SIM by phone number

`POST /subscriber/sim/{mdn}/assign`

Attach an eligible unassigned SIM to your account using its MDN and verificationCode. Already assigned or already activated SIMs are rejected. Read the returned SIM before continuing to activation.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `MDN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| mdn | path | Yes | SIM phone number. Keep this value as text. |

Request schema: AssignSimSubscriberDto.

```json
{
  "verificationCode": "REPLACE_ME"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${MDN}/assign" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "verificationCode": "REPLACE_ME"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_assignSim.mjs) · [Python](examples/python/sim_sim_assignSim.py) · [Rust](examples/rust/src/bin/sim_sim_assignSim.rs) · [Ruby](examples/ruby/sim_sim_assignSim.rb)

### Assign a SIM by ESN

`POST /subscriber/sim/esn/{esn}/assign`

Attach an eligible SIM using its ESN/ICCID. Its original order email must match your subscriber email. A SIM with an MDN must use the phone-number assignment flow.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `ESN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| esn | path | Yes | SIM ESN/ICCID. Keep this value as text. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/esn/${ESN}/assign" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_assignSimByEsn.mjs) · [Python](examples/python/sim_sim_assignSimByEsn.py) · [Rust](examples/rust/src/bin/sim_sim_assignSimByEsn.rs) · [Ruby](examples/ruby/sim_sim_assignSimByEsn.rb)

### Assign multiple SIMs

`POST /subscriber/sim/assign`

Submit SIM ESNs in the sims array. The email on each related order must match your subscriber email. Review your SIM list after assignment before activating.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: AssignSimsSubscriberDto.

```json
{
  "sims": [
    {
      "esn": "12341234123"
    }
  ]
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/assign" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "sims": [
    {
      "esn": "12341234123"
    }
  ]
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_assignSimEsns.mjs) · [Python](examples/python/sim_sim_assignSimEsns.py) · [Rust](examples/rust/src/bin/sim_sim_assignSimEsns.rs) · [Ruby](examples/ruby/sim_sim_assignSimEsns.rb)

### Activate a SIM with a plan

`POST /subscriber/sim/{simId}/activate`

Use an owned SIM that has not already been activated and is not already associated with a plan. Choose compatible active plan pricing. This request creates the payment flow for activation; payment initiation alone does not confirm activation. Include the E911 address fields when using Wi-Fi calling.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: ActivateSimSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "planPricingId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/activate" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "planPricingId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_activateSim.mjs) · [Python](examples/python/sim_sim_activateSim.py) · [Rust](examples/rust/src/bin/sim_sim_activateSim.rs) · [Ruby](examples/ruby/sim_sim_activateSim.rb)

### Retry activation of a paid SIM

`POST /subscriber/sim/{simId}/reactivate`

For eligible SIMs with an existing paid order whose activation has not completed. The order must exist and be paid. For a disconnected subscription use reconnect instead. Read the returned SIM details and confirm activation.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: ReActivateSimSubscriberDto.

```json
{
  "zipCodeActivation": "10001",
  "wfcEnabled": false
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/reactivate" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "zipCodeActivation": "10001",
  "wfcEnabled": false
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_reactivateSim.mjs) · [Python](examples/python/sim_sim_reactivateSim.py) · [Rust](examples/rust/src/bin/sim_sim_reactivateSim.rs) · [Ruby](examples/ruby/sim_sim_reactivateSim.rb)

### Check SIM status with a device IMEI

`POST /subscriber/sim/{simId}/check-sim-status`

Submit the device IMEI for an owned SIM to check its current status through the operator service. Read the returned result before proceeding with activation.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: DeviceCheckByImeiDtoPublic.

```json
{
  "imei": "356938035643809"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/check-sim-status" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "imei": "356938035643809"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_checkSimStatus.mjs) · [Python](examples/python/sim_sim_checkSimStatus.py) · [Rust](examples/rust/src/bin/sim_sim_checkSimStatus.rs) · [Ruby](examples/ruby/sim_sim_checkSimStatus.rb)

## Renewal and plan changes

Read your SIM's current plan, extend its validity through renewal, or switch to another eligible plan. Calculate the action price first using your SIM identifier, planPricingId and action type. Review charges, refund amounts and quote messages before proceeding. Complete payment, then read the current plan again to confirm the resulting product and validity.

### Quote renewal, plan change or reconnect

`POST /subscriber/sim/price`

Supply one SIM identifier: simId or mdnOrEsn, plus planPricingId and type. Use sim_renewal, plan_change or sim_reconnect as listed in the request enum. The plan source and SIM source must match. Price items may include refundAmount and message for a plan change; read these alongside total. Quote and purchase are separate calls.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: CalculatePlanActionPriceSubscriberDto.

```json
{
  "simId": "11111111-1111-4111-8111-111111111111",
  "planPricingId": "11111111-1111-4111-8111-111111111111",
  "type": "sim_renewal"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "simId": "11111111-1111-4111-8111-111111111111",
  "planPricingId": "11111111-1111-4111-8111-111111111111",
  "type": "sim_renewal"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_calculatePrice.mjs) · [Python](examples/python/sim_sim_calculatePrice.py) · [Rust](examples/rust/src/bin/sim_sim_calculatePrice.rs) · [Ruby](examples/ruby/sim_sim_calculatePrice.rb)

### Get the SIM current plan

`GET /subscriber/sim/{simId}/plan`

Read the current plan subscription for an owned, activated SIM. A SIM without an active plan returns an error. Use the current pricing and status when deciding whether to renew or change plans.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/sim/${SIM_ID}/plan" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_plan_sim_getActivePlan.mjs) · [Python](examples/python/sim_plan_sim_getActivePlan.py) · [Rust](examples/rust/src/bin/sim_plan_sim_getActivePlan.rs) · [Ruby](examples/ruby/sim_plan_sim_getActivePlan.rb)

### Renew a SIM plan

`POST /subscriber/sim/{simId}/plan/renew`

Quote the renewal first. Send compatible planPricingId if selecting a duration; when omitted, your current pricing is used. This creates a renewal payment. Complete payment and refresh the current plan to confirm the resulting validity.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: RenewSimSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "planPricingId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/plan/renew" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "planPricingId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_plan_sim_renewPlan.mjs) · [Python](examples/python/sim_plan_sim_renewPlan.py) · [Rust](examples/rust/src/bin/sim_plan_sim_renewPlan.rs) · [Ruby](examples/ruby/sim_plan_sim_renewPlan.rb)

### Change a SIM plan

`POST /subscriber/sim/{simId}/plan/change`

Quote with type=plan_change first and review charges or credits. Choose an available active plan pricing compatible with your SIM. If the chosen plan is already active, use renewal. The result initiates payment for the plan change.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: ChangeSimPlanSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "planPricingId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/plan/change" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "planPricingId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_plan_sim_changePlan.mjs) · [Python](examples/python/sim_plan_sim_changePlan.py) · [Rust](examples/rust/src/bin/sim_plan_sim_changePlan.rs) · [Ruby](examples/ruby/sim_plan_sim_changePlan.rb)

## Automatic renewal and add-ons

Manage automatic renewal and automatic add-on extension for an individual SIM. Configure the corresponding payment method in your subscriber account before enabling either feature. Auto-extend uses selected compatible add-ons and data, voice or SMS thresholds. After enabling or disabling a setting, read the current plan to confirm it; disabling auto-extend also clears its stored thresholds and add-on selections.

### Enable automatic renewal

`POST /subscriber/sim/{simId}/plan/auto_renew/enable`

Configure an automatic-renewal payment method in your subscriber account first. This enables renewal for this SIM current plan. Read the current plan after the update to confirm the setting.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/plan/auto_renew/enable" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_plan_sim_enableAutoRenew.mjs) · [Python](examples/python/sim_plan_sim_enableAutoRenew.py) · [Rust](examples/rust/src/bin/sim_plan_sim_enableAutoRenew.rs) · [Ruby](examples/ruby/sim_plan_sim_enableAutoRenew.rb)

### Disable automatic renewal

`POST /subscriber/sim/{simId}/plan/auto_renew/disable`

Disable automatic renewal on this SIM current plan, then read the current plan to confirm.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/plan/auto_renew/disable" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_plan_sim_disableAutoRenew.mjs) · [Python](examples/python/sim_plan_sim_disableAutoRenew.py) · [Rust](examples/rust/src/bin/sim_plan_sim_disableAutoRenew.rs) · [Ruby](examples/ruby/sim_plan_sim_disableAutoRenew.rb)

### Enable automatic add-on extension

`POST /subscriber/sim/{simId}/plan/auto_extend/enable`

Select eligible add-ons and thresholds for data, voice and SMS. Configure an auto-extend payment method in your account first. The SIM must have an eligible regular plan. Re-read the plan after saving.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: EnableAutoExtendSubscriberDto.

```json
{
  "smsThreshold": 10,
  "smsAutoExtendAddOnPlanId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/plan/auto_extend/enable" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "smsThreshold": 10,
  "smsAutoExtendAddOnPlanId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_plan_sim_enableAutoExtend.mjs) · [Python](examples/python/sim_plan_sim_enableAutoExtend.py) · [Rust](examples/rust/src/bin/sim_plan_sim_enableAutoExtend.rs) · [Ruby](examples/ruby/sim_plan_sim_enableAutoExtend.rb)

### Disable automatic add-on extension

`POST /subscriber/sim/{simId}/plan/auto_extend/disable`

Disables auto-extend and clears the stored thresholds and selected automatic add-on IDs for this plan subscription.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/plan/auto_extend/disable" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_plan_sim_disableAutoExtend.mjs) · [Python](examples/python/sim_plan_sim_disableAutoExtend.py) · [Rust](examples/rust/src/bin/sim_plan_sim_disableAutoExtend.rs) · [Ruby](examples/ruby/sim_plan_sim_disableAutoExtend.rb)

## SIM recovery

Check whether an original SIM is eligible for recovery, reconnect an eligible disconnected subscription, or move recovery onto a compatible active SIM you already own. Start with the eligibility check and applicable quote, then follow the purchase or owned-SIM recovery flow. Use recovery records to inspect progress, obtain the record ID for a supported retry, and confirm the outcome. Replacement cards use a separate activation step with their ESN and activation code.

### List recovery records

`GET /subscriber/sim/recovery`

List your recovery records with optional MDN and status filters. Use these records to inspect progress and obtain simRecoveryId for an eligible retry.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| page | query | Yes | Page number for pagination |
| limit | query | Yes | Number of items per page |
| mdn | query | No | Filter by MDN. Partial matches are supported. |
| status | query | No | Derived recovery status. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/sim/recovery" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_getSimRecoveries.mjs) · [Python](examples/python/sim_sim_getSimRecoveries.py) · [Rust](examples/rust/src/bin/sim_sim_getSimRecoveries.rs) · [Ruby](examples/ruby/sim_sim_getSimRecoveries.rb)

### Reconnect a disconnected SIM

`POST /subscriber/sim/{simId}/reconnect`

For an owned disconnected subscription with active compatible plan pricing. Quote with type=sim_reconnect, then initiate payment here. Reconnection is subject to the eligibility of your subscription. Check your SIM status after payment to confirm completion.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: ReconnectSimSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "planPricingId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/reconnect" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "planPricingId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_reconnectSim.mjs) · [Python](examples/python/sim_sim_reconnectSim.py) · [Rust](examples/rust/src/bin/sim_sim_reconnectSim.rs) · [Ruby](examples/ruby/sim_sim_reconnectSim.rb)

### Check recovery eligibility

`GET /subscriber/sim/check_recoverability/{simId}`

Check the original SIM before choosing recovery. Read the returned eligibility result and reason; do not infer eligibility from age or from an earlier quote.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/sim/check_recoverability/${SIM_ID}" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_checkRecoverability.mjs) · [Python](examples/python/sim_sim_checkRecoverability.py) · [Rust](examples/rust/src/bin/sim_sim_checkRecoverability.rs) · [Ruby](examples/ruby/sim_sim_checkRecoverability.rb)

### Purchase SIM recovery

`POST /subscriber/sim/{simId}/recovery/purchase`

Check recoverability and quote first. To recover onto an eligible active SIM you own, send newEsn; its plan pricing can be resolved automatically. Otherwise supply the requested planPricingId and applicable shipping details for a new physical SIM. Complete the returned payment flow, then inspect recovery records.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: PurchaseSimRecoverySubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "newEsn": "89148000001234567890"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/recovery/purchase" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "newEsn": "89148000001234567890"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_recoverySim.mjs) · [Python](examples/python/sim_sim_recoverySim.py) · [Rust](examples/rust/src/bin/sim_sim_recoverySim.rs) · [Ruby](examples/ruby/sim_sim_recoverySim.rb)

### Quote SIM recovery

`POST /subscriber/sim/{simId}/recovery/purchase/price`

Use the same newEsn, planPricingId and delivery details intended for recovery purchase. When newEsn identifies an eligible owned active SIM, its plan pricing can be resolved automatically. Read the total before proceeding.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: CalculateSimRecoveryPurchasePriceSubscriberDto.

```json
{
  "newEsn": "89148000001234567890"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/recovery/purchase/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "newEsn": "89148000001234567890"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_calculateSimRecoveryPurchasePrice.mjs) · [Python](examples/python/sim_sim_calculateSimRecoveryPurchasePrice.py) · [Rust](examples/rust/src/bin/sim_sim_calculateSimRecoveryPurchasePrice.rs) · [Ruby](examples/ruby/sim_sim_calculateSimRecoveryPurchasePrice.rb)

### Recover using an existing owned SIM

`POST /subscriber/sim/{simId}/recovery/esn`

Use an eligible active target SIM owned by the same subscriber. Send its newEsn; target plan pricing is derived from its active subscription. The target provider must match the original SIM. A success response confirms the request result; inspect recovery records for the recovery outcome.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: RecoverSimWithOwnEsnSubscriberDto.

```json
{
  "newEsn": "89148000001234567890"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/recovery/esn" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "newEsn": "89148000001234567890"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_recoverSimWithOwnEsn.mjs) · [Python](examples/python/sim_sim_recoverSimWithOwnEsn.py) · [Rust](examples/rust/src/bin/sim_sim_recoverSimWithOwnEsn.rs) · [Ruby](examples/ruby/sim_sim_recoverSimWithOwnEsn.rb)

### Activate the replacement recovery SIM

`POST /subscriber/sim/{simId}/recovery/esn/activate`

After the recovery fulfillment flow supplies the replacement card and activation code, send newEsn and activationCode for the original simId. Refresh recovery records and SIM details afterward.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: ActivateSimWithRecoverySimSubscriberDto.

```json
{
  "activationCode": "REPLACE_ME",
  "newEsn": "REPLACE_ME"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/recovery/esn/activate" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "activationCode": "REPLACE_ME",
  "newEsn": "REPLACE_ME"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_activateRecoverySim.mjs) · [Python](examples/python/sim_sim_activateRecoverySim.py) · [Rust](examples/rust/src/bin/sim_sim_activateRecoverySim.rs) · [Ruby](examples/ruby/sim_sim_activateRecoverySim.rb)

### Retry an eligible recovery record

`POST /subscriber/sim/recovery/retry`

Use simRecoveryId from your recovery records. Provide newEsn when the retry needs an eligible replacement. The service validates record ownership and retry state. Check the existing record before retrying an uncertain response.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: RetryRecoverySimDto.

```json
{
  "simRecoveryId": "123e4567-e89b-12d3-a456-426614174000"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/recovery/retry" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "simRecoveryId": "123e4567-e89b-12d3-a456-426614174000"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_retryRecoverySim.mjs) · [Python](examples/python/sim_sim_retryRecoverySim.py) · [Rust](examples/rust/src/bin/sim_sim_retryRecoverySim.rs) · [Ruby](examples/ruby/sim_sim_retryRecoverySim.rb)

## SIM refresh

Refresh a SIM's phone number or move its existing number to a replacement card. Select the refresh type carefully: mdn replaces the number and deactivates the old number, while esn moves the current number to a different SIM. Quote the same ZIP code, card and delivery options before submitting the refresh. If a replacement card is issued, complete its activation using the supplied ESN and activation code.

### Refresh a SIM number or card

`POST /subscriber/sim/{simId}/refresh`

Choose refreshType carefully: mdn replaces the phone number and deactivates the old number; esn moves the current number to a replacement SIM. Choose whether a new card is needed. Quote the same refresh options first. Supply replacement/delivery information as applicable. This is a separate flow from recovering a disconnected SIM; eligibility is validated for the selected refresh action.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: RefreshSimMdnEsnSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "refreshType": "mdn",
  "newZip": "10001",
  "buyNewSim": false
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/refresh" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "refreshType": "mdn",
  "newZip": "10001",
  "buyNewSim": false
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_refreshSim.mjs) · [Python](examples/python/sim_sim_refreshSim.py) · [Rust](examples/rust/src/bin/sim_sim_refreshSim.rs) · [Ruby](examples/ruby/sim_sim_refreshSim.rb)

### Activate a replacement refresh SIM

`POST /subscriber/sim/{simId}/refresh/esn/activate`

Use the replacement ESN and activation code from the refresh fulfillment workflow. Read SIM details after the activation request.

**Response:** Carrier refresh result. A false status is converted to an HTTP error; on success re-read the replacement SIM.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: ActivateSimWithRefreshSimSubscriberDto.

```json
{
  "activationCode": "REPLACE_ME",
  "newEsn": "REPLACE_ME"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/refresh/esn/activate" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "activationCode": "REPLACE_ME",
  "newEsn": "REPLACE_ME"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_activateRefreshSim.mjs) · [Python](examples/python/sim_sim_activateRefreshSim.py) · [Rust](examples/rust/src/bin/sim_sim_activateRefreshSim.rs) · [Ruby](examples/ruby/sim_sim_activateRefreshSim.rb)

### Quote a SIM refresh

`POST /subscriber/sim/{simId}/refresh/price`

Quote the refresh type, new ZIP code and new-card/delivery options before submitting the refresh request. Carrier eligibility, valid ZIP code and available shipping rate are checked.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: CalculateRefreshSimPriceSubscriberDto.

```json
{
  "refreshType": "mdn",
  "newZip": "10001",
  "buyNewSim": false
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/refresh/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "refreshType": "mdn",
  "newZip": "10001",
  "buyNewSim": false
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_calculateRefreshSimPrice.mjs) · [Python](examples/python/sim_sim_calculateRefreshSimPrice.py) · [Rust](examples/rust/src/bin/sim_sim_calculateRefreshSimPrice.rs) · [Ruby](examples/ruby/sim_sim_calculateRefreshSimPrice.rb)

## SIM transfers

Transfer ownership of SIMs between subscriber accounts. Upload a CSV containing ESN/ICCID values and provide the recipient's email address, then track outgoing and incoming requests. The recipient accepts or rejects pending transfers; the sender can cancel them. Review both transfer status and the SIM list to confirm completion. This is an account ownership transfer, separate from number porting between carriers.

### List outgoing transfers

`GET /subscriber/sim/transfer/out`

Review transfers you sent, optionally filtered by status. Use transfer IDs from this result to cancel pending transfers where allowed.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| page | query | No | Page number for pagination |
| limit | query | No | Number of items per page |
| status | query | No | Filter by transfer status. Accepts 0/PENDING, 1/ACCEPTED, 2/REJECTED, 3/CANCELLED |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/sim/transfer/out" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_getSimTransferOut.mjs) · [Python](examples/python/sim_sim_getSimTransferOut.py) · [Rust](examples/rust/src/bin/sim_sim_getSimTransferOut.rs) · [Ruby](examples/ruby/sim_sim_getSimTransferOut.rb)

### List incoming transfers

`GET /subscriber/sim/transfer/in`

Review incoming transfers and their status. Use transfer IDs from this result to accept or reject pending transfers.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| page | query | No | Page number for pagination |
| limit | query | No | Number of items per page |
| status | query | No | Filter by transfer status. Accepts 0/PENDING, 1/ACCEPTED, 2/REJECTED, 3/CANCELLED |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/sim/transfer/in" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_getSimTransferIn.mjs) · [Python](examples/python/sim_sim_getSimTransferIn.py) · [Rust](examples/rust/src/bin/sim_sim_getSimTransferIn.rs) · [Ruby](examples/ruby/sim_sim_getSimTransferIn.rb)

### Send SIM transfer requests by CSV

`POST /subscriber/sim/bulk/transfer`

Upload multipart/form-data with file and email. email is the destination subscriber email. The CSV must have a header named esn or iccid and at least one data row. Only .csv files up to 15 MiB are accepted. Keep ICCIDs as text to preserve all digits. Duplicate ESNs are removed. Submission creates transfer requests; the recipient must accept before ownership changes.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `RECIPIENT_EMAIL`, `CSV_FILE`. See the introduction for setup and download instructions.

Request schema: BulkSimTransferSubscriberDto.

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/transfer" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --form "email=${RECIPIENT_EMAIL}" \
  --form "file=@${CSV_FILE}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_bulkTransfer.mjs) · [Python](examples/python/sim_sim_bulkTransfer.py) · [Rust](examples/rust/src/bin/sim_sim_bulkTransfer.rs) · [Ruby](examples/ruby/sim_sim_bulkTransfer.rb)

### Accept, reject or cancel transfers

`PATCH /subscriber/sim/transfer`

Use transfer IDs from the incoming or outgoing lists and select the action from the schema. Only pending transfers can be changed. The recipient accepts or rejects; the sender cancels. Supply either simTransferId or simTransferIds (up to 100 IDs). Refresh the transfer list and your SIM list afterward.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: SimTransferActionSubscriberDto.

```json
{
  "simTransferId": "11111111-1111-4111-8111-111111111111",
  "action": "accept"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request PATCH "${API_ORIGIN}/subscriber/sim/transfer" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "simTransferId": "11111111-1111-4111-8111-111111111111",
  "action": "accept"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_updateSimTransfer.mjs) · [Python](examples/python/sim_sim_updateSimTransfer.py) · [Rust](examples/rust/src/bin/sim_sim_updateSimTransfer.rs) · [Ruby](examples/ruby/sim_sim_updateSimTransfer.rb)

## Add-ons

Purchase additional allowances, activate owned add-ons on compatible SIMs, and inspect activation history. The purchased add-on list returns your owned instances; subscriberAddOnPlanId identifies an owned instance and addOnPlanId identifies a product. Quote purchases or changes before paying, and check whether a change requires account balance. Activate a usable add-on on an eligible SIM, then read its activation history to confirm the result.

### List add-on activations on a SIM

`GET /subscriber/sim/{simId}/add-on_plan_activations`

Read the add-on activation history for an owned SIM. Use this after activation to confirm the associated add-on record.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/sim/${SIM_ID}/add-on_plan_activations" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_getAddOnPlanActivations.mjs) · [Python](examples/python/sim_sim_getAddOnPlanActivations.py) · [Rust](examples/rust/src/bin/sim_sim_getAddOnPlanActivations.rs) · [Ruby](examples/ruby/sim_sim_getAddOnPlanActivations.rb)

### Purchase add-ons directly for a SIM

`POST /subscriber/sim/{mdnOrEsn}/addons/purchase`

Use the owned SIM MDN or ESN in the URL and selected add-on IDs in the body. The request initiates the SIM-specific add-on purchase payment flow. Check the SIM add-on activations after payment.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `MDN_OR_ESN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| mdnOrEsn | path | Yes | Owned SIM phone number or ESN/ICCID. |

Request schema: UserPurchaseAddOnPlansSimDto.

```json
{
  "paymentGateway": "stripe",
  "addOnPlanIds": [
    "11111111-1111-4111-8111-111111111111"
  ]
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${MDN_OR_ESN}/addons/purchase" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "addOnPlanIds": [
    "11111111-1111-4111-8111-111111111111"
  ]
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_purchaseAddonPlans.mjs) · [Python](examples/python/sim_sim_purchaseAddonPlans.py) · [Rust](examples/rust/src/bin/sim_sim_purchaseAddonPlans.rs) · [Ruby](examples/ruby/sim_sim_purchaseAddonPlans.rb)

### List your purchased add-ons

`GET /subscriber/add-on_plans`

Returns add-ons already belonging to your account, with an optional isActivated filter. The list includes activatedAt when available. For eligible add-on products on a SIM, use bulk/check/eligibility with the appropriate add-on action.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| isActivated | query | No | See schema. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/add-on_plans" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/addOnPlan_getAll.mjs) · [Python](examples/python/addOnPlan_getAll.py) · [Rust](examples/rust/src/bin/addOnPlan_getAll.rs) · [Ruby](examples/ruby/addOnPlan_getAll.rb)

### Get a purchased add-on

`GET /subscriber/add-on_plans/{subscriberAddOnPlanId}`

Use subscriberAddOnPlanId from your purchased add-on list. This identifies your owned instance, not the add-on catalog product.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SUBSCRIBER_ADD_ON_PLAN_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| subscriberAddOnPlanId | path | Yes | Owned add-on instance ID from your purchased add-on list. |

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request GET "${API_ORIGIN}/subscriber/add-on_plans/${SUBSCRIBER_ADD_ON_PLAN_ID}" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}"
```

Download complete programs: [JavaScript](examples/javascript/addOnPlan_getById.mjs) · [Python](examples/python/addOnPlan_getById.py) · [Rust](examples/rust/src/bin/addOnPlan_getById.rs) · [Ruby](examples/ruby/addOnPlan_getById.rb)

### Purchase add-ons for your account

`POST /subscriber/add-on_plans/purchase`

Choose addOnPlanIds and quote first. You must already have at least one assigned SIM. Complete payment, then obtain subscriberAddOnPlanId from your purchased add-on list and activate it on a compatible SIM. ZIP selection may be restricted by prior physical purchases.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: PurchaseAddOnPlanSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "addOnPlanIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "zipCode": "10001"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/add-on_plans/purchase" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "addOnPlanIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "zipCode": "10001"
}'
```

Download complete programs: [JavaScript](examples/javascript/addOnPlan_purchaseAddon.mjs) · [Python](examples/python/addOnPlan_purchaseAddon.py) · [Rust](examples/rust/src/bin/addOnPlan_purchaseAddon.rs) · [Ruby](examples/ruby/addOnPlan_purchaseAddon.rb)

### Quote an add-on purchase

`POST /subscriber/add-on_plans/purchase/price`

Quote the selected addOnPlanIds and applicable zipCode. Read items, subTotal and total, including applicable surcharge, before creating payment.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: CalculateAddonPurchasePriceSubscriberDto.

```json
{
  "addOnPlanIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "zipCode": "10001"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/add-on_plans/purchase/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "addOnPlanIds": [
    "11111111-1111-4111-8111-111111111111"
  ],
  "zipCode": "10001"
}'
```

Download complete programs: [JavaScript](examples/javascript/addOnPlan_calculatePurchasePrice.mjs) · [Python](examples/python/addOnPlan_calculatePurchasePrice.py) · [Rust](examples/rust/src/bin/addOnPlan_calculatePurchasePrice.rs) · [Ruby](examples/ruby/addOnPlan_calculatePurchasePrice.rb)

### Quote changing an owned add-on

`POST /subscriber/add-on_plans/change/price`

Identify the owned subscriberAddOnPlanId, the target newAddOnPlanId and SIM. Review total and requiresBalanceOnly before selecting a payment method for the change.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: ChangePricingAddOnPlanSubscriberDto.

```json
{
  "simId": "11111111-1111-4111-8111-111111111111",
  "subscriberAddOnPlanId": "11111111-1111-4111-8111-111111111111",
  "newAddOnPlanId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/add-on_plans/change/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "simId": "11111111-1111-4111-8111-111111111111",
  "subscriberAddOnPlanId": "11111111-1111-4111-8111-111111111111",
  "newAddOnPlanId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/addOnPlan_calculateChangePrice.mjs) · [Python](examples/python/addOnPlan_calculateChangePrice.py) · [Rust](examples/rust/src/bin/addOnPlan_calculateChangePrice.rs) · [Ruby](examples/ruby/addOnPlan_calculateChangePrice.rb)

### Change an owned add-on

`POST /subscriber/add-on_plans/change`

Quote first. Depending on the calculated change, this returns an updated owned add-on or starts payment. Honor requiresBalanceOnly from the quote; when a gateway is needed, provide paymentGateway. Read your purchased add-on after completion.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: ChangeAddOnPlanSubscriberDto.

```json
{
  "simId": "11111111-1111-4111-8111-111111111111",
  "subscriberAddOnPlanId": "11111111-1111-4111-8111-111111111111",
  "newAddOnPlanId": "11111111-1111-4111-8111-111111111111",
  "paymentGateway": "balance",
  "zipCode": "10001"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/add-on_plans/change" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "simId": "11111111-1111-4111-8111-111111111111",
  "subscriberAddOnPlanId": "11111111-1111-4111-8111-111111111111",
  "newAddOnPlanId": "11111111-1111-4111-8111-111111111111",
  "paymentGateway": "balance",
  "zipCode": "10001"
}'
```

Download complete programs: [JavaScript](examples/javascript/addOnPlan_changeAddOnPlan.mjs) · [Python](examples/python/addOnPlan_changeAddOnPlan.py) · [Rust](examples/rust/src/bin/addOnPlan_changeAddOnPlan.rs) · [Ruby](examples/ruby/addOnPlan_changeAddOnPlan.rb)

### Activate an owned add-on on a SIM

`POST /subscriber/add-on_plans/activate`

Use an unactivated, unexpired owned add-on and an activated compatible SIM with a usable current plan. Follow the request schema for subscriberAddOnPlanId or addOnPlanId selection. Renew an expired zombie plan before activating an add-on.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: ActivateAddOnPlanSubscriberDto.

```json
{
  "subscriberAddOnPlanId": "11111111-1111-4111-8111-111111111111",
  "simId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/add-on_plans/activate" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "subscriberAddOnPlanId": "11111111-1111-4111-8111-111111111111",
  "simId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/addOnPlan_activateAddon.mjs) · [Python](examples/python/addOnPlan_activateAddon.py) · [Rust](examples/rust/src/bin/addOnPlan_activateAddon.rs) · [Ruby](examples/ruby/addOnPlan_activateAddon.rb)

## Bulk actions

Perform supported actions across multiple SIMs, including renewals, plan changes, add-ons and refreshes. Check eligibility first, select compatible pricing for each SIM, calculate the bulk price, and submit the same items with your payment method. The eligibility request requires 2–1,000 unique ESNs. Dedicated bulk renewal and refresh routes have their own request structures and quote endpoints. Verify each affected SIM after payment and processing.

### Submit bulk renewals

`POST /subscriber/sim/bulk/renew`

The dedicated renewal workflow takes a nonempty data array. Each item needs simId or simEsn; omitted planPricingId uses the current pricing. Quote using bulk/renew/price first. The service processes the renewal workflow; inspect each SIM after payment/processing.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: BulkRenewSimSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "data": [
    {
      "simId": "11111111-1111-4111-8111-111111111111",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    }
  ]
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/renew" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "data": [
    {
      "simId": "11111111-1111-4111-8111-111111111111",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    }
  ]
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_bulkRenewSim.mjs) · [Python](examples/python/sim_sim_bulkRenewSim.py) · [Rust](examples/rust/src/bin/sim_sim_bulkRenewSim.rs) · [Ruby](examples/ruby/sim_sim_bulkRenewSim.rb)

### Quote bulk renewals

`POST /subscriber/sim/bulk/renew/price`

Send a nonempty data array containing one identifier per SIM and optional planPricingId. Omitted planPricingId uses the current plan pricing. Review items and total before submitting bulk/renew.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: CalculateRenewSimPriceSubscriberDto.

```json
{
  "data": [
    {
      "simId": "11111111-1111-4111-8111-111111111111",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    }
  ]
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/renew/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "data": [
    {
      "simId": "11111111-1111-4111-8111-111111111111",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    }
  ]
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_calculateBulkRenewPrice.mjs) · [Python](examples/python/sim_sim_calculateBulkRenewPrice.py) · [Rust](examples/rust/src/bin/sim_sim_calculateBulkRenewPrice.rs) · [Ruby](examples/ruby/sim_sim_calculateBulkRenewPrice.rb)

### Submit bulk refreshes

`POST /subscriber/sim/bulk/refresh`

Submit the selected refresh type, SIM identifiers and replacement/delivery options after quoting. Check each SIM after the payment and refresh process.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: BulkRefreshSimMdnEsnSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "refreshType": "mdn",
  "esns": [
    "89148000001234567890",
    "89148000001234567891"
  ],
  "newZip": "10001",
  "buyNewSim": false
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/refresh" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "refreshType": "mdn",
  "esns": [
    "89148000001234567890",
    "89148000001234567891"
  ],
  "newZip": "10001",
  "buyNewSim": false
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_bulkRefreshSim.mjs) · [Python](examples/python/sim_sim_bulkRefreshSim.py) · [Rust](examples/rust/src/bin/sim_sim_bulkRefreshSim.rs) · [Ruby](examples/ruby/sim_sim_bulkRefreshSim.rb)

### Quote bulk refreshes

`POST /subscriber/sim/bulk/refresh/price`

Quote the refresh type, ESNs, new ZIP and shipping options. The service rejects unavailable SIMs, unsupported states/providers, invalid ZIP codes or unavailable shipping rates.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: CalculateRefreshSimPriceSubscriberDto.

```json
{
  "refreshType": "mdn",
  "esns": [
    "89148000001234567890",
    "89148000001234567891"
  ],
  "newZip": "10001",
  "buyNewSim": false
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/refresh/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "refreshType": "mdn",
  "esns": [
    "89148000001234567890",
    "89148000001234567891"
  ],
  "newZip": "10001",
  "buyNewSim": false
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_calculateBulkRefreshPrice.mjs) · [Python](examples/python/sim_sim_calculateBulkRefreshPrice.py) · [Rust](examples/rust/src/bin/sim_sim_calculateBulkRefreshPrice.rs) · [Ruby](examples/ruby/sim_sim_calculateBulkRefreshPrice.rb)

### Check bulk action eligibility

`POST /subscriber/sim/bulk/check/eligibility`

Start here for a multi-SIM action. Supply the action type and 2–1,000 unique ESNs. Read each eligibility result and available add-on options before building the quote; do not assume all SIMs support the same operation.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: BulkSimEligibilityDto.

```json
{
  "type": "extend",
  "esns": [
    "89014103211118510720",
    "89014103211118510721"
  ]
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/check/eligibility" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "extend",
  "esns": [
    "89014103211118510720",
    "89014103211118510721"
  ]
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_checkBulkSimActionEligibility.mjs) · [Python](examples/python/sim_sim_checkBulkSimActionEligibility.py) · [Rust](examples/rust/src/bin/sim_sim_checkBulkSimActionEligibility.rs) · [Ruby](examples/ruby/sim_sim_checkBulkSimActionEligibility.rb)

### Quote a bulk action

`POST /subscriber/sim/bulk/price`

Submit the action type and per-SIM items selected after checking eligibility. Duplicate ESNs and missing pricing are rejected. Review item-level prices and the total before submitting the same items for purchase.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: BulkSimActionSubscriberDto.

```json
{
  "type": "renew_plan",
  "items": [
    {
      "esn": "89148000001234567890",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    },
    {
      "esn": "89148000001234567891",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    }
  ]
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "renew_plan",
  "items": [
    {
      "esn": "89148000001234567890",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    },
    {
      "esn": "89148000001234567891",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    }
  ]
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_bulkSimActionPrice.mjs) · [Python](examples/python/sim_sim_bulkSimActionPrice.py) · [Rust](examples/rust/src/bin/sim_sim_bulkSimActionPrice.rs) · [Ruby](examples/ruby/sim_sim_bulkSimActionPrice.rb)

### Purchase a bulk action

`POST /subscriber/sim/bulk/purchase`

Submit the quoted action type and items plus the payment gateway. Supported types cover refresh, renewal, add-ons and plan changes as shown in the enum. Complete payment and verify every affected SIM; submission does not establish that all SIM actions have finished.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: BulkSimActionPurchaseSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "type": "renew_plan",
  "items": [
    {
      "esn": "89148000001234567890",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    },
    {
      "esn": "89148000001234567891",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    }
  ]
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/purchase" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "type": "renew_plan",
  "items": [
    {
      "esn": "89148000001234567890",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    },
    {
      "esn": "89148000001234567891",
      "planPricingId": "11111111-1111-4111-8111-111111111111"
    }
  ]
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_bulkSimActionPurchase.mjs) · [Python](examples/python/sim_sim_bulkSimActionPurchase.py) · [Rust](examples/rust/src/bin/sim_sim_bulkSimActionPurchase.rs) · [Ruby](examples/ruby/sim_sim_bulkSimActionPurchase.rb)

### Find eligible pricing for bulk actions

`POST /subscriber/sim/bulk/plan_pricings`

Get eligible plans and price options for renewal or plan change on the specified SIM IDs or ESNs. Use each SIM eligible pricing when constructing bulk items.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`. See the introduction for setup and download instructions.

Request schema: BulkSimPlanPricingsDto.

```json
{
  "type": "renew_plan",
  "esns": [
    "89148000001234567890",
    "89148000001234567891"
  ]
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/bulk/plan_pricings" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "renew_plan",
  "esns": [
    "89148000001234567890",
    "89148000001234567891"
  ]
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_sim_bulkPlanPricings.mjs) · [Python](examples/python/sim_sim_bulkPlanPricings.py) · [Rust](examples/rust/src/bin/sim_sim_bulkPlanPricings.rs) · [Ruby](examples/ruby/sim_sim_bulkPlanPricings.rb)

## Replacement SIMs

Quote and purchase a replacement SIM or an eligible switch between a physical card and eSIM. Check the SIM's allowed-switch flags before requesting a format change. Use matching delivery details for the quote and purchase, complete payment, and follow the resulting fulfillment and activation steps. A purchase response alone does not confirm shipment or activation.

### Purchase a replacement SIM

`POST /subscriber/sim/{simId}/reorder/purchase`

Quote replacement and delivery first. Submit shipping contact, address and rate details to initiate payment for replacing this SIM. Complete fulfillment before following the operator activation steps.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: ReorderSimSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "shippingFirstName": "Alex",
  "shippingLastName": "Example",
  "shippingPhoneNumber": "+12025550123",
  "shippingAddress1": "123 Example Street",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingCountry": "US",
  "shippingZipcode": "10001",
  "shippingRateId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/reorder/purchase" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "shippingFirstName": "Alex",
  "shippingLastName": "Example",
  "shippingPhoneNumber": "+12025550123",
  "shippingAddress1": "123 Example Street",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingCountry": "US",
  "shippingZipcode": "10001",
  "shippingRateId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_reorder_sim_purchase.mjs) · [Python](examples/python/sim_reorder_sim_purchase.py) · [Rust](examples/rust/src/bin/sim_reorder_sim_purchase.rs) · [Ruby](examples/ruby/sim_reorder_sim_purchase.rb)

### Quote a replacement SIM

`POST /subscriber/sim/{simId}/reorder/purchase/price`

Calculate the replacement card and delivery charges for your SIM using the intended shipping details. Read total before purchase.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: CalculateReorderSimPriceSubscriberDto.

```json
{
  "shippingAddress1": "123 Example Street",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingCountry": "US",
  "shippingZipcode": "10001",
  "shippingRateId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/reorder/purchase/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "shippingAddress1": "123 Example Street",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingCountry": "US",
  "shippingZipcode": "10001",
  "shippingRateId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_reorder_sim_calculateChangeSimSourcePrice.mjs) · [Python](examples/python/sim_reorder_sim_calculateChangeSimSourcePrice.py) · [Rust](examples/rust/src/bin/sim_reorder_sim_calculateChangeSimSourcePrice.rs) · [Ruby](examples/ruby/sim_reorder_sim_calculateChangeSimSourcePrice.rb)

### Purchase a physical SIM or eSIM switch

`POST /subscriber/sim/{simId}/sim_source/change/purchase`

Check allowedSwitchToPhysicalSim or allowedSwitchToESim on the SIM, then quote the switch. Supply shipping information when switching to a physical card. Complete payment and the resulting fulfillment/activation flow.

**Response:** Gateway-specific payment result: Stripe checkout session, PayPal order, CoinPayments transaction/invoices, Payssion or WeChatPay request, Airwallex order with paymentId, or a balance transaction with payment. Complete the selected gateway flow and confirm the related order/SIM state. No universal operation UUID or data envelope is returned.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: ChangeSimSourceSubscriberDto.

```json
{
  "paymentGateway": "stripe",
  "shippingFirstName": "Alex",
  "shippingLastName": "Example",
  "shippingPhoneNumber": "+12025550123",
  "shippingAddress1": "123 Example Street",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingCountry": "US",
  "shippingZipcode": "10001",
  "shippingRateId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/sim_source/change/purchase" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentGateway": "stripe",
  "shippingFirstName": "Alex",
  "shippingLastName": "Example",
  "shippingPhoneNumber": "+12025550123",
  "shippingAddress1": "123 Example Street",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingCountry": "US",
  "shippingZipcode": "10001",
  "shippingRateId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_simSource_sim_purchase.mjs) · [Python](examples/python/sim_simSource_sim_purchase.py) · [Rust](examples/rust/src/bin/sim_simSource_sim_purchase.rs) · [Ruby](examples/ruby/sim_simSource_sim_purchase.rb)

### Quote a physical SIM or eSIM switch

`POST /subscriber/sim/{simId}/sim_source/change/purchase/price`

Available only when the SIM allows the requested physical/eSIM switch. Use the same delivery information intended for purchase; the quote includes applicable charges.

**Response:** Expand the response schema below for the declared fields.

**Examples:** Identifiers are illustrative. Replace every placeholder and review optional/conditional fields before sending a request.

**Complete programs:** Select JavaScript, Python, Rust or Ruby in the code panel. Required environment: `API_ORIGIN`, `SUBSCRIBER_ACCESS_TOKEN`, `SIM_ID`. See the introduction for setup and download instructions.

| Parameter | Location | Required | Meaning |
| --- | --- | --- | --- |
| simId | path | Yes | Owned SIM UUID from your SIM list. |

Request schema: CalculateChangeSimSourcePriceSubscriberDto.

```json
{
  "shippingAddress1": "123 Example Street",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingCountry": "US",
  "shippingZipcode": "10001",
  "shippingRateId": "11111111-1111-4111-8111-111111111111"
}
```

```sh
# Set API_ORIGIN to your operator host and SUBSCRIBER_ACCESS_TOKEN to your session token.
# Set every path variable shown below before running.
curl --request POST "${API_ORIGIN}/subscriber/sim/${SIM_ID}/sim_source/change/purchase/price" \
  --header "Authorization: Bearer ${SUBSCRIBER_ACCESS_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{
  "shippingAddress1": "123 Example Street",
  "shippingCity": "New York",
  "shippingState": "NY",
  "shippingCountry": "US",
  "shippingZipcode": "10001",
  "shippingRateId": "11111111-1111-4111-8111-111111111111"
}'
```

Download complete programs: [JavaScript](examples/javascript/sim_simSource_sim_calculateChangeSimSourcePrice.mjs) · [Python](examples/python/sim_simSource_sim_calculateChangeSimSourcePrice.py) · [Rust](examples/rust/src/bin/sim_simSource_sim_calculateChangeSimSourcePrice.rs) · [Ruby](examples/ruby/sim_simSource_sim_calculateChangeSimSourcePrice.rb)

# Field reference

Required means unconditional validation/declaration. Conditional requirements still apply for shipping, selected payment gateways and action-specific identifiers.

## PriceQuote

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| items | array | Yes |  |
| subTotal | number | Yes | Subtotal calculated by this quote. |
| total | number | Yes | Total with applicable calculated charges. |

## ApiError

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| statusCode | integer | No |  |
| message | See OpenAPI | No |  |
| error | string | No | Error description or application code, for example SIM_NOT_FOUND. |

## SubscriberCurrentPlan

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | No |  |
| simSubscriptionId | string | No |  |
| plan | FormattedPlanDto | No |  |
| planPricing | FormattedPlanPricingDto | No |  |
| autoRenew | boolean | No |  |
| autoExtend | boolean | No |  |
| bandwidthThreshold | number | No |  |
| callMinutesThreshold | number | No |  |
| smsThreshold | number | No |  |
| bandwidthAutoExtendAddOnPlan | object | No |  |
| callMinutesAutoExtendAddOnPlan | object | No |  |
| smsAutoExtendAddOnPlan | object | No |  |
| bandwidthAutoExtendAddOnPlanId | string | No |  |
| callMinutesAutoExtendAddOnPlanId | string | No |  |
| smsAutoExtendAddOnPlanId | string | No |  |
| startedAt | string | No |  |
| expiresAt | string | No |  |
| releasedAt | string | No |  |
| createdAt | string | No |  |
| updatedAt | string | No |  |

## OwnedAddOn

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | No |  |
| subscriberId | string | No |  |
| addOnPlan | object | No | Add-on product details. |
| shortCode | string | No |  |
| mustActivateBefore | string | No |  |
| addOnPlanActivationId | string | No |  |
| isActivated | boolean | No |  |
| orderId | string | No |  |
| simId | string | No |  |
| sim | object | No |  |
| createdAt | string | No |  |
| updatedAt | string | No |  |
| cancelledAt | string | No |  |

## AddOnActivation

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | No |  |
| planSubscriptionId | string | No |  |
| addOnPlan | object | No |  |
| createdAt | string | No |  |
| updatedAt | string | No |  |

## SubscriptionUpdateResult

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| affected | integer | No | Number of updated records, when supplied by the database driver. |
| raw | See OpenAPI | No | Driver-specific update result. |
| generatedMaps | array | No |  |

## PublicPlanQueryDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| isActive | boolean | No | Is Active. |
| simSourceId | string | No | Sim Source Id. |
| includeEquivalentSimSourceType | boolean | No | Include Equivalent Sim Source Type. |
| planCategoryName | string | No | Plan Category Name. |
| planCategoryId | string | No | Plan Category Id. |

## FormattedPlanDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| providerReferenceId | string | No | Provider Reference Id. |
| subProviderReferenceId | string | No | Sub Provider Reference Id. |
| name | string | Yes | Name. |
| planCategory | FormattedPlanCategoryRefDto | No | Plan Category. |
| planCategoryId | string | No | Plan Category Id. |
| simSource | FormattedPlanSimSourceDto | No | Sim Source. |
| description | string | No | Description. |
| guideline | string | No | Guideline. |
| instruction | string | No | Instruction. |
| type | string | No | Action or resource type; use one of the listed values. Values: regular, zombie, acp, tribal, restricted. |
| bandwidth | number | No | Bandwidth. |
| dailyBandwidthThreshold | number | No | Daily Bandwidth Threshold. |
| dailyHighSpeedBandwidthThreshold | number | No | Daily High Speed Bandwidth Threshold. |
| hasNumber | boolean | No | Has Number. |
| dataOnly | boolean | No | Data Only. |
| networkProvider | string | No | Network Provider. |
| network | string | No | Network. |
| callMinutes | number | No | Call Minutes. |
| sms | number | No | Sms. |
| isPublic | boolean | No | Is Public. |
| overageBandwidthCost | number | No | Overage Bandwidth Cost. |
| overageMinuteCost | number | No | Overage Minute Cost. |
| overageSmsCost | number | No | Overage Sms Cost. |
| isActive | boolean | No | Is Active. |
| nonInitPlan | boolean | No | Non Init Plan. |
| coverage | array | No | Coverage. |
| speed | string | No | Speed. |
| dataUnit | string | No | Data Unit. |
| validityMode | string | No | Validity Mode. |
| isFupCode | boolean | No | Is Fup Code. |
| roaming | string | No | Roaming. |
| requiresEid | boolean | No | Requires Eid. |
| requiresImei2 | boolean | No | Requires Imei2. |
| parentSourcePlanId | string | No | Parent Source Plan Id. |
| createdAt | string | Yes | Created At. |
| updatedAt | string | Yes | Updated At. |

## FormattedPlanCategoryRefDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| name | string | Yes | Name. |
| createdAt | string | Yes | Created At. |
| updatedAt | string | Yes | Updated At. |

## FormattedPlanSimSourceDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| requireUsZipCode | boolean | No | Require Us Zip Code. |
| allowedUsageLog | boolean | No | Allowed Usage Log. |
| allowedAddOns | boolean | No | Allowed Add Ons. |
| allowedPaymentGateways | array | No | Allowed Payment Gateways. |
| type | string | No | Action or resource type; use one of the listed values. Values: sim, e_sim. |
| simCardPrice | number | No | Sim Card Price. |

## PublicPlanPricingQueryDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| planId | string | No | Plan product ID from the available plan list. |
| simSourceId | string | No | Sim Source Id. |
| includeEquivalentSimSourceType | boolean | No | Include Equivalent Sim Source Type. |
| isActive | boolean | No | Is Active. |

## FormattedPlanPricingDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| planId | string | No | Plan product ID from the available plan list. |
| plan | FormattedPlanDto | No | Plan. |
| duration | number | Yes | Duration. |
| durationUnit | string | Yes | Duration Unit. Values: day, month, year. |
| price | number | Yes | Price for this item. |
| discountedPrice | number | No | Discounted Price. |
| calculatedPrice | number | No | Calculated Price. |
| isActive | boolean | Yes | Is Active. |
| createdAt | string | Yes | Created At. |
| updatedAt | string | Yes | Updated At. |

## GetSimsSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| esn | array | No | ESN/ICCID search terms. Partial, case-insensitive matches are used. Maximum 1000 items. |
| mdn | array | No | MDN/MSISDN search terms. Partial, case-insensitive matches are used. Maximum 1000 items. |
| simSourceId | string | No | Filter by a specific SIM source UUID. |
| includeEquivalentSimSourceType | boolean | No | When simSourceId is present, include SIM sources with the same provider instead of only the exact source. |
| eligibleForRecovery | boolean | No | When simSourceId is present, return only active regular SIMs eligible for recovery with the same source provider. |
| planId | string | No | Filter by plan UUID. |
| autoRenew | boolean | No | Filter by plan subscription auto-renew setting. |
| isActive | boolean | No | Filter by SIM activation state. |
| simStatus | See OpenAPI | No | Possible values: active, inactive, destroyed |
| simPlanStatus | See OpenAPI | No | Possible values: no_plan, disconnected, not_disconnected, suspended, expired, in_use |
| page | integer | No | Page number for pagination. Pagination is applied only when both page and limit are provided. |
| limit | integer | No | Number of SIMs per page. Pagination is applied only when both page and limit are provided. |

## SimListResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| data | array | Yes | Data. |
| total | number | Yes | Calculated total including applicable charges. |
| page | number | Yes | Page number. See the schema default and allowed values. |
| limit | number | Yes | Maximum number of records requested per page. |

## FormattedSimDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| esn | string | Yes | SIM ESN/ICCID. Keep this value as text. |
| mdn | string | No | SIM phone number. Keep this value as text. |
| imsi | string | No | Imsi. |
| simSource | SimSourceDto | No | Sim Source. |
| sourceDetails | SimSourceDetailsDto | No | Source Details. |
| valid | boolean | Yes | Valid. |
| qrCode | string | No | Qr Code. |
| orderCode | string | Yes | Order Code. |
| isForTestingPurposes | boolean | Yes | Is For Testing Purposes. |
| simSubscription | SimSubscriptionDto | No | Sim Subscription. |
| chainRefreshHistoryId | string | Yes | Chain Refresh History Id. |
| activatedAt | string | No | Activated At. |
| activationAt | string | No | Activation At. |
| expirationAt | string | No | Expiration At. |
| providerStatus | string | No | Provider Status. |
| destroyedAt | string | No | Destroyed At. |
| createdAt | string | Yes | Created At. |
| updatedAt | string | Yes | Updated At. |
| simStatus | string | Yes | Sim Status. Values: destroyed, inactive, active. |
| simPlanStatus | string | Yes | Sim Plan Status. Values: no_plan, disconnected, plan_inactive, processing, suspended, expired, used_up, in_use. |
| portedOut | boolean | Yes | Ported Out. |
| portedOutDate | string | No | Date or string per upstream provider; often ISO date-time |
| isEligibleToTransfer | boolean | No | Is Eligible To Transfer. |
| allowedAddOnPlan | boolean | No | Allowed Add On Plan. |
| allowedRenew | boolean | No | Allowed Renew. |
| allowedChangePlan | boolean | No | Allowed Change Plan. |
| allowedRefreshEsn | boolean | No | Allowed Refresh Esn. |
| allowedRefreshMdn | boolean | No | Allowed Refresh Mdn. |
| allowedReconnect | boolean | No | Allowed Reconnect. |
| allowedSimActivation | boolean | No | Allowed Sim Activation. |
| allowedPortOut | boolean | No | Allowed Port Out. |
| allowedPortIn | boolean | No | Allowed Port In. |
| allowedWifi | boolean | No | Allowed Wifi. |
| allowedReOrderPhysicalSim | boolean | No | Allowed Re Order Physical Sim. |
| allowedSwitchToPhysicalSim | boolean | No | Allowed Switch To Physical Sim. |
| allowedSwitchToESim | boolean | No | Allowed Switch To ESim. |
| allowedRecovery | boolean | No | Allowed Recovery. |

## SimSourceDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| type | string | Yes | Action or resource type; use one of the listed values. Values: sim, e_sim. |
| haveNumber | boolean | Yes | Have Number. |
| country | string | No | Country. |
| simCardPrice | number | Yes | Sim Card Price. |
| mdnRefreshPrice | number | Yes | Mdn Refresh Price. |
| esnRefreshPrice | number | Yes | Esn Refresh Price. |
| maxRefreshCount | number | Yes | Max Refresh Count. |
| minPurchaseCount | number | Yes | Min Purchase Count. |
| imsi | string | No | Imsi. |
| supportRealTimeEsim | boolean | No | Support Real Time Esim. |
| maxRenewGracePeriod | number | No | Max Renew Grace Period. |
| portIn | boolean | Yes | Port In. |
| portOut | boolean | Yes | Port Out. |
| requireUsZipCode | boolean | Yes | Require Us Zip Code. |
| optionalUsAddress | boolean | No | Optional Us Address. |
| allowedUsageLog | boolean | Yes | Allowed Usage Log. |
| allowedPaymentGateways | array | No | Allowed Payment Gateways. |
| createdAt | string | Yes | Created At. |
| updatedAt | string | Yes | Updated At. |

## SimSourceDetailsDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| orderId | string | No | Order Id. |
| providerDetails | ProviderDetailsDto | No | Provider Details. |

## ProviderDetailsDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| e911AddressLine1 | string | No | E911Address Line1. |
| e911AddressLine2 | string | No | E911Address Line2. |
| e911AddressCity | string | No | E911Address City. |
| e911AddressState | string | No | E911Address State. |
| e911AddressZipCode | string | No | E911Address Zip Code. |
| wfcEnabled | boolean | No | Wfc Enabled. |
| wfcFailureCause | string | No | Wfc Failure Cause. |
| eSimProfile | ESimProfileDto | No | E Sim Profile. |
| data | number | No | Data. |
| totalData | number | No | Total Data. |
| totalUsageData | number | No | Total Usage Data. |
| voice | number | No | Voice. |
| totalVoice | number | No | Total Voice. |
| totalUsageVoice | number | No | Total Usage Voice. |
| sms | number | No | Sms. |
| totalSms | number | No | Total Sms. |
| totalUsageSms | number | No | Total Usage Sms. |
| scheduledActivationAt | string | No | Scheduled Activation At. |
| scheduledExpirationAt | string | No | Scheduled Expiration At. |
| providerActivationAt | string | No | Provider Activation At. |
| providerExpirationAt | string | No | Provider Expiration At. |
| providerStatus | string | No | Provider Status. |
| siteKey | string | No | Site Key. |

## ESimProfileDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| error | string | No | Provider error message if any |
| profileState | string | No | Provider profile state if any |

## SimSubscriptionDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| subscriberId | string | No | Subscriber Id. |
| simId | string | Yes | Owned SIM UUID from your SIM list. |
| zipCode | string | No | Applicable postal/ZIP code. |
| planSubscription | object | No | Formatted PlanSubscription or null |
| status | boolean | Yes | Status. |
| createdAt | string | Yes | Created At. |
| updatedAt | string | Yes | Updated At. |

## GetSubscriberSimRecoveryDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| page | number | Yes | Page number for pagination |
| limit | number | Yes | Number of items per page |
| mdn | string | No | Filter by MDN. Partial matches are supported. |
| status | string | No | Derived recovery status. Values: pending, completed, canceled, failed. |

## PaginationDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| page | number | Yes | Page number for pagination |
| limit | number | Yes | Number of items per page |

## GetAllSimRecoverySubscriberResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| data | array | Yes | Data. |
| total | number | Yes | Total matched recovery records. |
| page | number | Yes | Current page. |
| limit | number | Yes | Page size. |

## SimRecoveryItemSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | SIM recovery UUID. |
| status | string | Yes | Derived recovery status. Values: pending, completed, canceled, failed. |
| simId | string | No | Original SIM UUID. |
| sim | SimRecoverySimDto | No | Original SIM details. |
| newSimId | string | No | Replacement SIM UUID. |
| newSim | SimRecoverySimDto | No | Replacement SIM details. |
| mdn | string | Yes | Recovered MDN. |
| newEsn | string | No | Requested replacement ESN. |
| activationCodeId | string | No | SIM activation code UUID. |
| planPricingId | string | No | Plan pricing UUID. |
| planPricing | SimRecoveryPlanPricingDto | No | Plan pricing details. |
| portInId | string | No | Port-in UUID. |
| portIn | SimRecoveryPortInDto | No | Port-in details. |
| orderId | string | No | Order UUID. |
| orderItemId | string | No | Order item UUID. |
| errorMessage | string | No | Recovery error message. |
| createdAt | string | Yes | Creation timestamp. |
| updatedAt | string | Yes | Last update timestamp. |

## SimRecoverySimDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | SIM UUID. |
| esn | string | No | SIM ESN or ICCID. |
| mdn | string | No | SIM MDN/MSISDN. |

## SimRecoveryPlanPricingDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Plan pricing UUID. |
| planId | string | No | Plan UUID. |
| duration | number | No | Plan duration. |
| durationUnit | string | No | Plan duration unit. |
| name | string | No | Plan display name. |

## SimRecoveryPortInDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Port-in UUID. |
| isCompleted | boolean | No | Whether the port-in completed. |
| isCanceled | boolean | No | Whether the port-in was canceled. |
| isFailed | boolean | No | Whether the port-in failed. |
| completedAt | string | No | Completion timestamp. |
| canceledAt | string | No | Cancellation timestamp. |
| failedAt | string | No | Failure timestamp. |
| lastCheckErrorMessage | string | No | Last status check error message. |
| simActivationCode | SimRecoveryPortInActivationCodeDto | No | Activation code used by the port-in request. |

## SimRecoveryPortInActivationCodeDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | SIM activation code UUID. |
| activationCode | string | No | Activation code. |
| activatedAt | string | No | Activation timestamp. |

## GetSimTransfersSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| page | integer | No | Page number for pagination |
| limit | integer | No | Number of items per page |
| status | See OpenAPI | No | Filter by transfer status. Accepts 0/PENDING, 1/ACCEPTED, 2/REJECTED, 3/CANCELLED Values: 0, 1, 2, 3, PENDING, ACCEPTED, REJECTED, CANCELLED. |

## PaginationDtoOptional

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| page | integer | No | Page number. See the schema default and allowed values. |
| limit | integer | No | Maximum number of records requested per page. |

## GetSimTransfersSubscriberResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| data | array | Yes | Data. |
| total | number | Yes | Calculated total including applicable charges. |
| page | number | Yes | Page number. See the schema default and allowed values. |
| limit | number | Yes | Maximum number of records requested per page. |

## SimTransferSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | SIM transfer UUID. |
| status | string | Yes | Transfer status. Values: PENDING, ACCEPTED, REJECTED, CANCELLED. |
| acceptedOn | string | No | Accepted timestamp. |
| rejectedOn | string | No | Rejected timestamp. |
| cancelledOn | string | No | Cancelled timestamp. |
| sim | object | No | SIM details. |
| fromSubscriber | object | No | Subscriber that initiated the transfer. |
| toSubscriber | object | No | Subscriber that receives the transfer. |

## BulkSimTransferSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| file | string | Yes | CSV file (.csv only, max 15MB). Row 1 must be a header row. Supported columns: esn\|iccid. Example content: esn\n89148000001234567890. |
| email | string | Yes | Destination subscriber email address. The recipient reviews incoming requests and accepts or rejects the transfer. |

## BulkSimTransferSubscriberResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| success | boolean | Yes | Whether the requested operation reported success. |
| message | string | Yes | Message. |

## SimTransferActionSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| simTransferId | string | No | SIM transfer UUID. Use either simTransferId or simTransferIds. Conditionally validated; additional requirements depend on the selected action and other fields. |
| simTransferIds | array | No | SIM transfer UUIDs for bulk action. Maximum 100 items. Use either simTransferId or simTransferIds. Conditionally validated; additional requirements depend on the selected action and other fields. |
| action | See OpenAPI | Yes | Action. Values: accept, reject, cancel. |

## SimTransferActionResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| success | boolean | Yes | Whether the requested operation reported success. |

## PurchaseSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| planPricingIds | array | Yes | Selected price and duration IDs from the available pricing list. |
| addOnPlanIds | array | Yes | Add-on product IDs. |
| deviceId | string | No | Device Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingFirstName | string | No | First name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingLastName | string | No | Last name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingPhoneNumber | string | No | Phone number is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress1 | string | No | Shipping Address1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Shipping Address2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Shipping City. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Shipping State. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Shipping Country. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Shipping Zipcode. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Shipping rate ID for the selected delivery address, supplied by your operator checkout. Conditionally validated; additional requirements depend on the selected action and other fields. |
| activationAddress1 | string | No | Activation Address1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| activationAddress2 | string | No | Activation Address2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| activationCity | string | No | Activation City. Conditionally validated; additional requirements depend on the selected action and other fields. |
| activationState | string | No | Activation State. Conditionally validated; additional requirements depend on the selected action and other fields. |
| activationCountry | string | No | Activation Country. Conditionally validated; additional requirements depend on the selected action and other fields. |
| zipCodeActivation | string | No | US ZIP code for activation, where required. May differ from the shipping ZIP code. Used to calculate applicable charges; otherwise the shipping ZIP code is used. |
| pushEsimDevices | array | No | Device identifiers for each applicable purchase item. |
| portIns | array | No | Per-item port-in details for purchased plan pricing items. |

## AirwallexPaymentDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| typeService | string | No | The type of flow of the service Values: default, web. |
| type | string | No | Airwallex payment method type returned by the available payment methods API. |
| details | object | No | Payment-method-specific Airwallex parameters. The required fields depend on the selected payment method. |

## PushEsimDeviceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| planPricingId | string | Yes | Plan pricing ID for this purchase item. |
| eid | string | Yes | Device EID. |
| imei2 | string | Yes | Device IMEI2. |

## PurchaseSimPortInDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| code | string | Yes | The 6-digit verification code received via SMS |
| planPricingId | string | Yes | Plan pricing ID for the port-in item. |
| mdn | string | Yes | SIM phone number. Keep this value as text. |
| zipCode | string | No | Applicable postal/ZIP code. Conditionally validated; additional requirements depend on the selected action and other fields. |
| authorizedBy | string | No | Authorized By. Conditionally validated; additional requirements depend on the selected action and other fields. |
| billing | PurchaseSimPortInBillingDto | Yes | Billing. |
| oldProvider | PurchaseSimPortInOldProviderDto | Yes | Old Provider. |
| wfcEnabled | boolean | Yes | If wfcEnabled = false then WFC will not be enabled for this Sim. If wfcEnabled = true and e911 Address is provided, then WFC will be enabled for this Sim (If address is valid, if not, WFC will not be enabled). If wfcEnabled = true and e911 Address is not provided, then WFC will be enabled to our office address as e911 Address for this Sim. |
| e911AddressLine1 | string | No | E911Address Line1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressLine2 | string | No | E911Address Line2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressCity | string | No | E911Address City. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressState | string | No | E911Address State. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressZipCode | string | No | E911Address Zip Code. Conditionally validated; additional requirements depend on the selected action and other fields. |

## PurchaseSimPortInBillingDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| firstName | string | No | First Name. Conditionally validated; additional requirements depend on the selected action and other fields. |
| lastName | string | No | Last Name. Conditionally validated; additional requirements depend on the selected action and other fields. |
| address | PurchaseSimPortInAddressDto | Yes | Address. |

## PurchaseSimPortInAddressDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| addressLine1 | string | No | Address Line1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| addressLine2 | string | No | Address Line2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| city | string | No | City. Conditionally validated; additional requirements depend on the selected action and other fields. |
| state | string | No | State. Conditionally validated; additional requirements depend on the selected action and other fields. |
| zip | string | No | Zip. Conditionally validated; additional requirements depend on the selected action and other fields. |

## PurchaseSimPortInOldProviderDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| account | string | No | Account. Conditionally validated; additional requirements depend on the selected action and other fields. |
| password | string | No | Password. Conditionally validated; additional requirements depend on the selected action and other fields. |

## CalculatePurchasePriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| planPricingIds | array | Yes | Plan pricing UUIDs to price. Duplicates are allowed to represent quantity. |
| addOnPlanIds | array | No | Optional add-on plan UUIDs. Duplicates are allowed to represent quantity. |
| deviceId | string | No | Optional device UUID to include in price calculation. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress1 | string | No | Shipping address line 1 (required when shipping calculation is needed). Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Shipping address line 2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Shipping city. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Shipping state/province. Must be 2-letter ISO code when shippingCountry is US or CA. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Shipping country. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Shipping ZIP/postal code. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Shipping rate UUID for physical SIM shipping pricing. Conditionally validated; additional requirements depend on the selected action and other fields. |
| zipCodeActivation | string | No | US ZIP code for activation, where required. May differ from the shipping ZIP code. Used to calculate applicable charges; otherwise the shipping ZIP code is used. |

## CalculatePurchaseSimPriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| planId | string | Yes | SIM provider and type will be retrieved from provider plan. |
| quantity | number | Yes | Number of units. |
| shippingAddress1 | string | No | Shipping Address1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Shipping Address2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Shipping City. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Shipping state/province. Must be 2-letter ISO code when shippingCountry is US or CA. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Shipping Country. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Shipping Zipcode. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Shipping rate ID for the selected delivery address, supplied by your operator checkout. Conditionally validated; additional requirements depend on the selected action and other fields. |
| zipCodeActivation | string | No | US ZIP code for activation, where required. May differ from the shipping ZIP code. Used to calculate applicable charges; otherwise the shipping ZIP code is used. |

## AssignSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| verificationCode | string | Yes | Verification Code. |

## AssignSimsSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| sims | array | Yes | ESNs to be assigned to subscriber |

## AssignEsnSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| esn | string | Yes | ESN to be assigned to subscriber |

## ActivateSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| planPricingId | string | Yes | Price and duration ID from plan pricing; distinct from planId. |
| wfcEnabled | boolean | No | If wfcEnabled = false then WFC will not be enabled for this Sim. If wfcEnabled = true and e911 Address is provided, then WFC will be enabled for this Sim (If address is valid, if not, WFC will not be enabled). If wfcEnabled = true and e911 Address is not provided, then WFC will be enabled to our office address as e911 Address for this Sim. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressLine1 | string | No | E911Address Line1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressLine2 | string | No | E911Address Line2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressCity | string | No | E911Address City. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressState | string | No | E911Address State. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressZipCode | string | No | E911Address Zip Code. Conditionally validated; additional requirements depend on the selected action and other fields. |

## ReActivateSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| zipCodeActivation | string | No | US ZIP code for activation, where required. Required if e911AddressZipCode is not provided. |
| wfcEnabled | boolean | No | If wfcEnabled = false then WFC will not be enabled for this Sim. If wfcEnabled = true and e911 Address is provided, then WFC will be enabled for this Sim (If address is valid, if not, WFC will not be enabled). If wfcEnabled = true and e911 Address is not provided, then WFC will be enabled to our office address as e911 Address for this Sim. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressLine1 | string | No | E911Address Line1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressLine2 | string | No | E911Address Line2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressCity | string | No | E911Address City. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressState | string | No | E911Address State. Conditionally validated; additional requirements depend on the selected action and other fields. |
| e911AddressZipCode | string | No | E911Address Zip Code. Conditionally validated; additional requirements depend on the selected action and other fields. |

## ReconnectSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| planPricingId | string | Yes | Price and duration ID from plan pricing; distinct from planId. |

## UserPurchaseAddOnPlansSimDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| addOnPlanIds | array | Yes | Add-on product IDs. |

## CalculatePlanActionPriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| mdnOrEsn | string | No | Provide MDN/ESN instead of SIM ID |
| simId | string | No | Provide SIM ID instead of MDN/ESN |
| planPricingId | string | Yes | Price and duration ID from plan pricing; distinct from planId. |
| type | string | Yes | Action or resource type; use one of the listed values. Values: sim_renewal, sim_reconnect, plan_change. |

## BulkRenewSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| data | array | Yes | Renew requests to process in the background. |

## BaseRenewSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |

## BulkRenewSimItemSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| simId | string | No | SIM UUID that is being Renewed. One of `simId`, `simEsn` is required. |
| simEsn | string | No | SIM ESN/ICCID to resolve SIM by latest `updatedAt` record. One of `simId`, `simEsn` is required. |
| planPricingId | string | No | Renew plan pricing UUID. When omitted, the SIM's current plan pricing is used. |

## CalculateRenewSimPriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| data | array | Yes | Renew requests to process in the background. |

## CalculateRenewSimPriceSubscriberResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| items | array | Yes | Itemized results. |
| subTotal | number | Yes | Calculated subtotal. |
| total | number | Yes | Calculated total including applicable charges. |

## CalculateRenewSimPriceItemResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| name | string | Yes | Name. |
| quantity | number | Yes | Number of units. |
| price | number | Yes | Price for this item. |

## BulkRefreshSimMdnEsnSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| refreshType | string | Yes | Type of refresh. Available values mdn or esn.<br>MDN - This request will provide a new MDN/MSISDN. Old telephone number will be deactivated.<br>ESN - This request will move an MDN/MSISDN to a new ESN/SIM. Note: The oldesn will now be available in inventory to reuse again for other transactions. Values: mdn, esn. |
| buyNewSim | boolean | No | Indicates whether the refresh comes with a new Sim/eSim. Default is false. |
| newZip | string | No | For refreshType=mdn, provide a valid US ZIP code for the new number's area. If omitted, the current subscription ZIP code is used where available. A ZIP code is required when no saved ZIP code is available. |
| shippingFirstName | string | No | First name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingLastName | string | No | Last name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingPhoneNumber | string | No | Phone number is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress1 | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| esns | array | No | Required for bulk refresh price calculation. |

## BaseRefreshSimMdnEsnSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| refreshType | string | Yes | Type of refresh. Available values mdn or esn.<br>MDN - This request will provide a new MDN/MSISDN. Old telephone number will be deactivated.<br>ESN - This request will move an MDN/MSISDN to a new ESN/SIM. Note: The oldesn will now be available in inventory to reuse again for other transactions. Values: mdn, esn. |
| buyNewSim | boolean | No | Indicates whether the refresh comes with a new Sim/eSim. Default is false. |
| newZip | string | No | For refreshType=mdn, provide a valid US ZIP code for the new number's area. If omitted, the current subscription ZIP code is used where available. A ZIP code is required when no saved ZIP code is available. |
| shippingFirstName | string | No | First name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingLastName | string | No | Last name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingPhoneNumber | string | No | Phone number is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress1 | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |

## CalculateRefreshSimPriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| esns | array | No | Required for bulk refresh price calculation. |
| refreshType | string | Yes | Type of refresh. Available values mdn or esn.<br>MDN - This request will provide a new MDN/MSISDN. Old telephone number will be deactivated.<br>ESN - This request will move an MDN/MSISDN to a new ESN/SIM. Note: The oldesn will now be available in inventory to reuse again for other transactions. Values: mdn, esn. |
| buyNewSim | See OpenAPI | No | Indicates whether the refresh comes with a new Sim/eSim. Default is false. |
| newZip | string | No | For refreshType=mdn, provide a valid US ZIP code for the new number's area. If omitted, the current subscription ZIP code is used where available. A ZIP code is required when no saved ZIP code is available. |
| shippingAddress1 | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |

## CalculateBulkRefreshPriceResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| items | array | Yes | Itemized results. |
| subTotal | number | Yes | Calculated subtotal. |
| total | number | Yes | Calculated total including applicable charges. |

## TransactionItem

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | No | Id. |
| name | string | Yes | Name. |
| quantity | number | Yes | Number of units. |
| price | number | Yes | Price for this item. |
| merchantGoodsId | string | No | Merchant Goods Id. |
| message | string | No | Message. |
| refundAmount | number | No | Refund Amount. |

## RefreshSimMdnEsnSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| refreshType | string | Yes | Type of refresh. Available values mdn or esn.<br>MDN - This request will provide a new MDN/MSISDN. Old telephone number will be deactivated.<br>ESN - This request will move an MDN/MSISDN to a new ESN/SIM. Note: The oldesn will now be available in inventory to reuse again for other transactions. Values: mdn, esn. |
| buyNewSim | boolean | No | Indicates whether the refresh comes with a new Sim/eSim. Default is false. |
| newZip | string | No | For refreshType=mdn, provide a valid US ZIP code for the new number's area. If omitted, the current subscription ZIP code is used where available. A ZIP code is required when no saved ZIP code is available. |
| shippingFirstName | string | No | First name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingLastName | string | No | Last name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingPhoneNumber | string | No | Phone number is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress1 | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Required if includes SIM is true and Refresh Type is ESN and SIM is physical Conditionally validated; additional requirements depend on the selected action and other fields. |
| newEsn | string | No | Replacement SIM ESN for refreshType=esn. If omitted, a replacement SIM is requested. Check your order for fulfillment progress. |

## ActivateSimWithRefreshSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| activationCode | string | Yes | Activation code issued for your SIM fulfillment. |
| newEsn | string | Yes | Target or replacement SIM ESN/ICCID. |

## CheckSimRecoverabilityResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| result | boolean | Yes | Whether SIM can be recovered |
| message | string | No | Reason when result is false Values: SIM_NOT_ACTIVE_OR_EXPIRED, SIM_ALREADY_PORTED_OUT_TO_ANOTHER_SERVICE, SIM_IS_EXPIRED_OVER_30_DAYS, SIM_IS_NOT_ELIGIBLE_FOR_RECOVERY, SIM_IS_NOT_ELIGIBLE_FOR_RECOVERY_AT_THE_MOMENT_TRY_AGAIN_LATER, MDN_NOT_ELIGIBLE_FOR_PORTING, SIM_IS_IN_USE, SIM_UNDER_RECOVERY, MDN_NOT_ELIGIBLE_FOR_PORTING_PORTING_IN_PROGRESS, REQUIRE_NEW_SIM. |

## PurchaseSimRecoverySubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment gateway used for recovery purchase. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | CoinPayments target coin symbol. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion payment method ID. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| newEsn | string | No | Target active SIM ESN/ICCID owned by the same subscriber. Used to recover onto an existing active SIM instead of reserving a new one. |
| planPricingId | string | No | Requested recovery plan pricing UUID. Optional when `newEsn` is provided and eligible; then it is auto-resolved from the target SIM's active plan pricing. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingFirstName | string | No | First name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingLastName | string | No | Last name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingPhoneNumber | string | No | Phone number is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress1 | string | No | Shipping address line 1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Shipping address line 2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Shipping city. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Shipping state or province code. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Shipping country code (for example: US). Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Shipping ZIP/postal code. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Shipping rate UUID for physical SIM shipment. Conditionally validated; additional requirements depend on the selected action and other fields. |

## CalculateSimRecoveryPurchasePriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| newEsn | string | No | Target active SIM ESN/ICCID owned by the same subscriber. Used to estimate recovery pricing when recovering onto an active SIM. |
| planPricingId | string | No | Requested recovery plan pricing UUID. Optional when `newEsn` is provided and eligible; then it is auto-resolved from the target SIM's active plan pricing. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress1 | string | No | Shipping address line 1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Shipping address line 2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Shipping city. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Shipping state or province code. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Shipping country code (for example: US). Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Shipping ZIP/postal code. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Shipping rate UUID for physical SIM shipment. Conditionally validated; additional requirements depend on the selected action and other fields. |

## RecoverSimWithOwnEsnSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| newEsn | string | Yes | Target active SIM ESN/ICCID owned by the same subscriber. |

## RecoverSimWithOwnEsnSubscriberResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| success | boolean | Yes | Whether the requested operation reported success. |

## ActivateSimWithRecoverySimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| activationCode | string | Yes | Activation code issued for your SIM fulfillment. |
| newEsn | string | Yes | Target or replacement SIM ESN/ICCID. |

## RetryRecoverySimDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| simRecoveryId | string | Yes | The ID of the SIM recovery to retry |
| newEsn | string | No | Replacement inactive SIM ESN/ICCID. Allowed only when the previous recovery failed with INVALID SIM and no active port-in exists. |

## DeviceCheckByImeiDtoPublic

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| imei | string | Yes | Imei. |

## DeviceCheckSimStatusResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| status | See OpenAPI | Yes | Status. |
| deviceStatus | string | Yes | Possible values: SIM_NOT_ACTIVE, NOT_REGISTERED, REGISTERED_TO_OTHER_DEVICE, REGISTERED |
| simActivated | boolean | Yes | Sim Activated. |
| networkRegistered | boolean | Yes | Network Registered. |
| registeredToThisDevice | boolean | Yes | Registered To This Device. |

## BulkSimEligibilityDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| type | string | Yes | Bulk action to check SIM eligibility for Values: refresh_mdn, refresh_esn, renew_plan, extend, change_plan, add_on_plan. |
| esns | array | Yes | SIM ESNs to check eligibility for the selected bulk action |

## BulkSimEligibilityResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| notEligibleDetails | array | No | List of non-eligible ESNs with reasons |
| eligible | array | Yes | List of SIMs that are eligible for the requested bulk action |

## BulkSimEligibilityNotEligibleDetailDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| esn | string | Yes | SIM ESN |
| reason | string | Yes | Reason why this SIM is not eligible.   **Possible values:** - `SIM_NOT_FOUND_OR_NOT_OWNED`: SIM not found or not owned by subscriber - `SIM_DESTROYED`: SIM is destroyed - `SIM_NOT_ACTIVATED`: SIM not activated - `SIM_REFRESHED`: SIM has been refreshed - `SIM_RECOVERED`: SIM has been recovered - `SIM_UNDER_RECOVERY`: SIM is currently under recovery - `SIM_PORTED_OUT`: SIM has been ported out - `SIM_PORT_OUT_COMPLETED`: Port-out process completed - `SUBSCRIPTION_NOT_FOUND`: Subscription not found - `NO_ACTIVE_PLAN`: No active plan subscription - `PLAN_NOT_FOUND`: Plan not found - `TRANSFER_IN_PROGRESS`: SIM transfer in progress - `SIM_IS_UNDER_RECOVERY_PORTING`: SIM under recovery porting - `SIM_RECOVERY_IN_PROGRESS`: SIM recovery in progress - `SIM_NOT_ALLOWED_ADD_ON_PLAN`: SIM not allowed for add-on plans - `SIM_EXPIRING_SOON`: SIM expires within 3 hours - `ADD_ON_PLAN_NOT_AVAILABLE`: Requested add-on plan not available - `IS_A_ACP_PLAN`: SIM is using an ACP plan - `SIM_NOT_ALLOWED_CHANGE_PLAN`: SIM not allowed to change plan - `BULK_ACTION_IN_PROGRESS:{ACTION_TYPE}`: Another bulk action is already in progress (e.g., `BULK_ACTION_IN_PROGRESS:BULK_PLAN_CHANGE`) |

## BulkSimEligibilityItemDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | SIM UUID |
| esn | string | Yes | SIM ESN |
| planId | string | Yes | Current plan UUID |
| planPricingId | string | Yes | Current plan pricing UUID |
| simSourceId | string | Yes | SIM source UUID |

## BulkSimActionSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| type | string | Yes | Bulk action to check SIM eligibility for Values: refresh_mdn, refresh_esn, renew_plan, extend, change_plan, add_on_plan. |
| items | array | Yes | List of SIM items with their respective plan pricing for the bulk action (or addOnPlanPricingId) |

## BulkSimPriceItemDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| esn | string | Yes | ESN of the SIM |
| planPricingId | string | No | Plan pricing UUID of the SIM |
| addOnPlanPricingId | string | No | Add-on plan pricing UUID of the SIM |
| addOnPlanPricingIds | array | No | Add-on plan pricing UUIDs of the SIM |

## BulkSimPriceResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| items | array | Yes | List of transaction items including plan changes or add-ons |
| subTotal | number | Yes | Sub-total amount before surcharges |
| total | number | Yes | Total amount including surcharges |

## BulkSimActionPurchaseSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| type | string | Yes | Bulk action to check SIM eligibility for Values: refresh_mdn, refresh_esn, renew_plan, extend, change_plan, add_on_plan. |
| items | array | Yes | List of SIM items with their respective plan pricing for the bulk action (or addOnPlanPricingId) |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |

## BulkSimPlanPricingsDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| type | string | Yes | Bulk action to list eligible plans for Values: renew_plan, change_plan. |
| simIds | array | No | SIM UUIDs to resolve. |
| esns | array | No | SIM ESNs/ICCIDs to resolve. |

## BulkSimPlanPricingsResponseItemDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| sims | array | Yes | Sims. |
| plans | array | Yes | Plans. |

## BulkSimPlanPricingSimDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| esn | string | No | SIM ESN/ICCID. Keep this value as text. |
| mdn | string | No | SIM phone number. Keep this value as text. |

## BulkSimEligiblePlanDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| name | string | Yes | Name. |
| simSourceId | string | Yes | Sim Source Id. |
| bandwidth | number | No | Bandwidth. |
| callMinutes | number | No | Call Minutes. |
| sms | number | No | Sms. |
| dataUnit | string | No | Data Unit. |
| requiresEid | boolean | No | Requires Eid. |
| requiresImei2 | boolean | No | Requires Imei2. |
| planPricings | array | Yes | Plan Pricings. |

## BulkSimPlanPricingItemDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Id. |
| planId | string | Yes | Plan product ID from the available plan list. |
| duration | number | Yes | Duration. |
| durationUnit | string | Yes | Duration Unit. Values: day, month, year. |
| price | number | Yes | Price for this item. |
| discountedPrice | number | No | Discounted Price. |

## EnableAutoExtendSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| bandwidthThreshold | number | No | Bandwidth Threshold. Conditionally validated; additional requirements depend on the selected action and other fields. |
| callMinutesThreshold | number | No | Call Minutes Threshold. Conditionally validated; additional requirements depend on the selected action and other fields. |
| smsThreshold | number | No | Sms Threshold. Conditionally validated; additional requirements depend on the selected action and other fields. |
| bandwidthAutoExtendAddOnPlanId | string | No | Bandwidth Auto Extend Add On Plan Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| callMinutesAutoExtendAddOnPlanId | string | No | Call Minutes Auto Extend Add On Plan Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| smsAutoExtendAddOnPlanId | string | No | Sms Auto Extend Add On Plan Id. Conditionally validated; additional requirements depend on the selected action and other fields. |

## RenewSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| planPricingId | string | No | Price and duration ID from plan pricing; distinct from planId. Conditionally validated; additional requirements depend on the selected action and other fields. |

## ChangeSimPlanSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| planPricingId | string | Yes | Price and duration ID from plan pricing; distinct from planId. |

## PurchaseAddOnPlanSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| zipCode | string | No | Applicable postal/ZIP code. Conditionally validated; additional requirements depend on the selected action and other fields. |
| addOnPlanIds | array | Yes | Add-on product IDs. |

## CalculateAddonPurchasePriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| zipCode | string | No | Applicable postal/ZIP code. Conditionally validated; additional requirements depend on the selected action and other fields. |
| addOnPlanIds | array | Yes | Add-on product IDs. |

## ChangePricingAddOnPlanSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| simId | string | Yes | Owned SIM UUID from your SIM list. |
| subscriberAddOnPlanId | string | Yes | Owned add-on instance ID from your purchased add-on list. |
| newAddOnPlanId | string | Yes | New Add On Plan Id. |
| zipCode | string | No | Applicable postal/ZIP code. Conditionally validated; additional requirements depend on the selected action and other fields. |

## ChangeAddOnPlanResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| requiresBalanceOnly | boolean | Yes | Indicates whether balance only is required for this transaction. |
| subTotal | number | Yes | The subtotal amount (change amount) for the add-on plan change. |
| total | number | Yes | The total amount including any applicable surcharges, formatted to 2 decimal places. |
| items | ChangeAddOnPlanItemDto | Yes | Array of transaction items including the add-on plan change and any surcharges. |

## ChangeAddOnPlanItemDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| name | string | Yes | Name. |
| quantity | number | Yes | Number of units. |
| price | number | Yes | Price for this item. |
| merchantGoodsId | string | Yes | Merchant Goods Id. |

## ChangeAddOnPlanSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | No | Payment method. Only gateways enabled by your operator for this action can be used. Conditionally validated; additional requirements depend on the selected action and other fields. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| simId | string | Yes | Owned SIM UUID from your SIM list. |
| subscriberAddOnPlanId | string | Yes | Owned add-on instance ID from your purchased add-on list. |
| newAddOnPlanId | string | Yes | New Add On Plan Id. |
| zipCode | string | No | Applicable postal/ZIP code. Conditionally validated; additional requirements depend on the selected action and other fields. |

## ChangeAddOnPlanSubscriberAddOnPlanResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Subscriber add-on plan UUID. |
| subscriberId | string | Yes | Subscriber UUID. |
| addOnPlan | object | Yes | Formatted add-on plan payload. |
| shortCode | string | Yes | Subscriber add-on plan short code. |
| mustActivateBefore | string | No | Deadline to activate this add-on plan. |
| addOnPlanActivationId | string | No | Add-on plan activation UUID. |
| isActivated | boolean | Yes | Whether this add-on plan is activated. |
| orderId | string | No | Order UUID linked to this add-on plan. |
| simId | string | No | Sim UUID linked to this add-on plan. |
| sim | ChangeAddOnPlanSubscriberSimResponseDto | No | Minimal formatted sim payload. |
| createdAt | string | Yes | Creation timestamp. |
| updatedAt | string | Yes | Last update timestamp. |

## ChangeAddOnPlanSubscriberSimResponseDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| id | string | Yes | Sim UUID assigned to this add-on plan. |
| mdn | string | No | Sim MDN value (if available). |
| esn | string | No | Sim ESN value (if available). |

## ActivateAddOnPlanSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| subscriberAddOnPlanId | string | No | Owned add-on instance ID from your purchased add-on list. Conditionally validated; additional requirements depend on the selected action and other fields. |
| addOnPlanId | string | No | Add-on product ID; distinct from your owned subscriberAddOnPlanId. Conditionally validated; additional requirements depend on the selected action and other fields. |
| simId | string | Yes | Owned SIM UUID from your SIM list. |

## ReorderSimSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingFirstName | string | Yes | Shipping First Name. |
| shippingLastName | string | Yes | Shipping Last Name. |
| shippingPhoneNumber | string | Yes | Shipping Phone Number. |
| shippingAddress1 | string | Yes | Shipping Address1. |
| shippingAddress2 | string | No | Shipping Address2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | Yes | Shipping City. |
| shippingState | string | No | Shipping State. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | Yes | Shipping Country. |
| shippingZipcode | string | Yes | Shipping Zipcode. |
| shippingRateId | string | Yes | Shipping rate ID for the selected delivery address, supplied by your operator checkout. |

## CalculateReorderSimPriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| shippingAddress1 | string | No | Shipping Address1. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Shipping Address2. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Shipping City. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Shipping State. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Shipping Country. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Shipping Zipcode. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Shipping rate ID for the selected delivery address, supplied by your operator checkout. Conditionally validated; additional requirements depend on the selected action and other fields. |

## ChangeSimSourceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| paymentGateway | string | Yes | Payment method. Only gateways enabled by your operator for this action can be used. Values: stripe, paypal, coinpayments, coinpayments_vip, payssion, airwallex, wechatpay, balance. |
| selectedCoinForCoinPayments | string | No | Selected Coin For Coin Payments. Conditionally validated; additional requirements depend on the selected action and other fields. |
| payssionPmId | string | No | Payssion Pm Id. Conditionally validated; additional requirements depend on the selected action and other fields. |
| airwallexPayment | AirwallexPaymentDto | No | Airwallex Payment Method Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingFirstName | string | No | First name is required if shipping address is provided Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingLastName | string | Yes | Last name is required if shipping address is provided |
| shippingPhoneNumber | string | Yes | Phone number is required if shipping address is provided |
| shippingAddress1 | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |

## CalculateChangeSimSourcePriceSubscriberDto

| Field | Type | Required | Meaning |
| --- | --- | --- | --- |
| shippingAddress1 | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingAddress2 | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCity | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingState | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingCountry | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingZipcode | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
| shippingRateId | string | No | Required if the new sim source type is a physical sim type. allowedSwitchToPhysicalSim = true in sim entity. Conditionally validated; additional requirements depend on the selected action and other fields. |
