Get an order

Order state.

• scheduled: reserved for a future scheduled purchase; no charge has been made.
• charging: payment is being obtained. If funds are insufficient, inspect funding and your wallet balance. One-time orders retry automatically; an initial recurring purchase requires an explicit retry after adding funds.
• provisioning: the package is being provisioned during the request.
• pending: the purchase continues after the request returns. Read the order again to check its outcome.
• completed: delivery completed and the eSIM and package IDs are available. This does not confirm device installation. Terminal.
• failed: delivery failed. Any charge is credited automatically; refund_transaction_id identifies an issued credit. Terminal.
• canceled: reserved for a scheduled purchase withdrawn before execution. Canceling an unfunded order currently returns failed with failure_code: canceled.

Possible values: scheduled, charging, provisioning, pending, completed, failed, canceled

Whether a purchase or eSIM is live or simulated. The mode is fixed when the order is created; the resulting eSIM retains it.

• live: purchases service for use on a device and charges the wallet.
• test: simulates a purchase without a charge or usable mobile service.

List responses can include both modes. Filter by mode when separating test activity from live purchases.

Possible values: live, test

Offer purchased.

Revision of the offer this order locked at creation. The quoted price stays that of this revision even if the offer changes later. The produced package snapshots its coverage at purchase; the zone's live country list governs new sales only.

Coverage zone of the purchased offer, captured at creation.

The eSIM the package lands on. Set at creation when adding to an existing eSIM; set when provisioning starts for a new-eSIM order; null before that.

Subscriber to assign when the new eSIM is delivered. Null when none was requested, including top-up orders, which retain the existing assignment.

The recurring service associated with this purchase. Absent for one-time orders.

The purchased data package, set when the order completes; null before that.

The quoted price, locked at creation in your billing currency. A mode: test order quotes this price and is never charged it, so its wallet_transaction_id stays null.

The wallet transaction that paid for this order, for reconciling against your billing transactions. Null until the charge lands, and always null for a mode: test order, which is never charged.

The wallet transaction that credited the charge back after a failure. Null unless the order failed after charging.

Where install credentials are delivered once available. Present when requested at creation.

Whether this order is in charging after an insufficient wallet balance refusal. The required balance is in funding when available. False does not confirm payment; check status and wallet_transaction_id. When absent, funding indicates a refusal if present; otherwise the funding state is unknown.

Details of an insufficient-funds attempt while the order is in charging. May be null even while the order is awaiting funds; a null value does not confirm payment. Check awaiting_funds to identify an outstanding insufficient-balance refusal.

Reason the order failed. Null unless status is failed. Handle unrecognized codes without assuming the purchase succeeded.

• canceled: canceled while awaiting funds.
• resolved_by_support: support closed an unresolved order as failed.
• esim_released: the target profile became unavailable before delivery.
• mode_mismatch: the purchase could not be fulfilled in its original live or test mode.

Any charge is credited automatically. Check refund_transaction_id to confirm an issued credit.

Possible values (may grow over time): insufficient_balance, carrier_error, capacity_exhausted, offer_unavailable, internal_error, canceled, resolved_by_support, esim_released, mode_mismatch

Why the order failed, in plain terms. Null unless status is failed.

When the order reached completed. Null before that.