Skip to main content

Retrieve an eSIM order

GET 

/v1/esim/orders/:order_id

Returns one order. Branch on object: a package purchase comes back as esim_order and carries the activation_code the create call returned, while a top-up comes back as esim_top_up_order and carries none — it added data to a profile that was already installed.

Re-reading a package order is how you recover install instructions without keeping the secret yourself.

If you are here because a create request timed out and you no longer have its Idempotency-Key, you will not have this id either — look the order up by your own reference instead.

An order found that way may still be settling, in which case it comes back without an esim_id or an activation_code (without a top_up_id, for a top-up). That is not an error and not a 404; it means the answer is not in yet.

Request​

Responses​

The order.