Get all orders
GET /orders
Get details on all previous orders, including total cost and contents. Response data is paginated.
Authorizations
Parameters
Query Parameters
Set to true to include eSIM data (ICCID, Matching ID and SMDP Address) in the response, and an ICCIDs array.
Note: From v2.3.0 onwards, this data will be included by default.
1Page number to return.
10Number of results to return per page.
lte:2024-03-31T23:59:59.999ZSpecifies the date range for filtering orders. This parameter has a ‘lte:’ prefix to specify the end date.
For example, to query orders from March 1, 2024, to March 31, 2024, use the following format:
createdAt=gte:2024-03-01T00:00:00.000Z&createdAt=lte:2024-03-31T23:59:59.999Z.
Responses
200
Success message
object
Items within the order
object
Item type. Supported: bundle,autoTopup, apiTopup, `topup“
Item name. This is the Bundle name when type = "bundle"
Quantity of item
Item Subtotal
Price per Item
Topup Invoice Link
Order total
Order currency
Status of the order
Order status message
Order Reference
Date/Time of order creation
Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’).
Example: 2006-01-02T15:04:05Z
400
Bad Request - returned when request format is not accepted
object
Status of api functions which do not return data
403
Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the eSIM is not accessible by the user
object
Status of api functions which do not return data
500
Server Error
object
Status of api functions which do not return data