Skip to main content
Every order response from the MIOeSIM API includes a status field containing an integer code that reflects the current state of that order. You will encounter this field in responses from getOrder, queryOrder, queryEsimOrder, and any other endpoint that returns order objects. Use the code to determine what actions are available on the order and what to display to your customers.

​
Status codes

​
Status transitions

Orders follow a typical path from creation through to expiry:
  1. Created — an order is placed and enters status -1 (not paid) until payment is confirmed.
  2. Active — once payment is confirmed, the order moves to status 0 (paid / normal). Activation codes and QR codes are now available.
  3. Ended — when all plans in the order expire or data is fully consumed, the order moves to status 5.
Orders that are cancelled before or during use move to status 2 (fully cancelled) or 4 (partial refund, when only some cards were cancelled). When a cancellation is submitted and is being processed, the order shows status 6 or 7 until the operation completes.
Orders in status 6 (unsubscribing) or 7 (partial unsubscribe in process) are locked while the cancellation is being processed. Do not attempt to renew, cancel, or otherwise modify the order until it settles into a terminal status.