get_order_status
Check order or checkout status. Guests: pass payment_link (preferred) or checkout_hash from create_order — no login; the hash is unguessable. Do not pass a sequential order_id without OAuth (IDs are enumerable). Do not ask the buyer for the hash or show it. OAuth / PRO: pass order_id (sandbox orders: sandbox_… id). If create_order timed out before returning order_id, pass its idempotency_key instead — never re-create. Fulfilled eSIM orders include iccid, lpa_string, install_url, a hosted qr_code_url PNG, remaining balance_amount (provider refresh only when last check is older than five minutes), and nested consumption (cron snapshot: activated, unlimited, data_remaining_gb, days_left). Fulfilled gift cards may include redemption_code or redemption_url.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_id | No | Sequential ticket ID. Always requires OAuth / API key. Do not use for guest checkout. | |
| payment_link | No | Checkout URL from create_order. Preferred guest status key — no login. Do not show the embedded hash to the buyer. | |
| checkout_hash | No | Machine identifier from create_order (32–64 hex). No login. Do not show to the buyer. Prefer payment_link. | |
| idempotency_key | No | OAuth / API key only. The idempotency_key sent to create_order when the create timed out before returning order_id. Finds that order without creating anything (24h, same account). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| iccid | No | ||
| status | No | ||
| order_id | No | Identifier (integer or numeric string). | |
| lpa_string | No | ||
| consumption | No | Cron snapshot for native My eSIMs. unlimited=true means data_remaining_gb is null. days_left is null until activated. | |
| install_url | No | ||
| qr_code_url | No | ||
| balance_unit | No | ||
| payment_link | No | ||
| show_to_user | No | Fields the assistant may show the buyer. | |
| checkout_hash | No | Machine identifier. Never show or read aloud. | |
| balance_amount | No | ||
| redemption_url | No | ||
| delivery_status | No | ||
| redemption_code | No | ||
| balance_checked_at | No | ||
| balance_expiration | No | ||
| checkout_hash_usage | No | machine_only | |
| assistant_instruction | No |