Returns the Orders created by the authenticated User. Reserved to Users with the Admin, Purchaser or Owner role. This endpoint is not paginated.
Responses
-
Orders fetched successfully
Hide response attributes Show response attributes object
-
The Order's ID
-
Statuses:
PENDING_APPROVAL- The Order is awaiting approval from an Admin / Purchaser / OwnerPENDING_PAYMENT- The Order is awaiting paymentPROCESSING- The Order is being processed by the network and should soon be fulfilledFULFILLED- The Order has been fulfilled and the associated Subscription / eSIM is readyCANCELLED- The Order has been cancelled before being chargedREFUNDED- The Order has been cancelled and its charge reversedFAILED- The Order has failed — seefailureReasonfor detailsREPLACED- The Order has been superseded by a newer oneIN_BASKET- The Order is currently sitting in the User's basket
Values are
PENDING_APPROVAL,PENDING_PAYMENT,PROCESSING,FULFILLED,CANCELLED,REFUNDED,FAILED,REPLACED, orIN_BASKET. -
The Account ID linked to the Order
-
The Plan ID linked to the Order
-
The User ID for which the Order was generated
-
Types:
ONE_OFF- The Order is a one-off purchaseTOP_UP- The Order tops up an existing SubscriptionRECURRING- The Order is part of a recurring Subscription (UK domestic plans)
Values are
ONE_OFF,TOP_UP, orRECURRING. -
If
true, the end User has been (or will be) notified about this Order. Returned withexpand=true. -
Free-text explanation set when
statusisFAILED. Returned withexpand=true. -
Hide plan attributes Show plan attributes object
-
LOCAL- single Destination *REGIONAL- a Region (several Destinations) *GLOBAL- worldwide coverage
Values are
LOCAL,REGIONAL, orGLOBAL. -
Values are
REGULAR,UNLIMITED, orMIXED. -
DATA- Data-only Plans *VOICE_AND_DATA- Plans including voice (and SMS) in addition to data
Values are
DATAorVOICE_AND_DATA. -
truefor recurring plans such as UK domestic plans -
Billing interval of recurring plans (
MONTHLYfor UK domestic plans),nullfor one-off plansValues are
DAILY,WEEKLY,MONTHLY,YEARLY, or null. -
Hide destination attributes Show destination attributes object
-
Possible values:
MB- MegaByte representationGB- GigaByte representation
Values are
MBorGB. -
Details:
- If
dataValue>= 0 then the plan is capped to that amount of consumable data - If
dataValue== -1 then the plan is unlimited and does not have a cap on consumable data
- If
-
Details:
MINUTES- Minutes representationHOURS- Hours representation
Values are
MINUTESorHOURS. -
Details:
- If
callValue>= 0 then the plan is capped to that amount of consumable call time - If
callValue== -1 then the plan is unlimited and does not have a cap on call time
- If
-
Details:
- If
smsValue>= 0 then the plan is capped to that amount of consumable SMS sent - If
smsValue== -1 then the plan is unlimited and does not have a cap on SMS sent
- If
-
Hide features attributes Show features attributes object
-
Possible values:
HOTSPOT- The plan does support the hotspot functionTOP_UP- The plan does support top up operations3G- The plan and its associated network supports speeds up to 3G4G- The plan and its associated network supports speeds up to 4G5G- The plan and its associated network supports speeds up to 5G
Values are
HOTSPOT,TOP_UP,3G,4G, or5G. -
Values are
UTILITY,BILLING, orNETWORK.
-
-
Hide prices attributes Show prices attributes object
-
The unit amount in minor units (e.g. cents, if supported), represented as a signed integer
-
Indicates the number of decimals in the price for currencies supporting this format or
0for zero-decimal currencies such asJPY. Examples:- A
USDpricevalueof 490 with aminorUnitsExponentof 2 would be $4.90 - A
JPYpricevalueof 775 with aminorUnitsExponentof 0 would be ¥775
- A
-
Present when a valid
discountCodewas applied — the price before discount, in minor units
-
Returned with
expand=trueonce the Order is fulfilledHide subscription attributes Show subscription attributes object
-
The Subscription's ID
-
Statuses:
PROCESSING- The Subscription is being processed and should be ready soonPENDING- The Subscription is ready and is pending first use by the UserACTIVE- The Subscription is currently active and used by the UserEXPIRED- The Subscription has expired and is no longer validCANCEL_PENDING- A cancellation was requested and is awaiting confirmation from the networkCANCELLED- The Subscription has been cancelledDEPLETED- The allocation of the Subscription has been fully consumed by the User
Values are
PROCESSING,PENDING,ACTIVE,EXPIRED,CANCEL_PENDING,CANCELLED, orDEPLETED. -
The associated eSIM ID
-
The associated Plan object (without prices)
Hide plan attributes Show plan attributes object
-
LOCAL- single Destination *REGIONAL- a Region (several Destinations) *GLOBAL- worldwide coverage
Values are
LOCAL,REGIONAL, orGLOBAL. -
Values are
REGULAR,UNLIMITED, orMIXED. -
DATA- Data-only Plans *VOICE_AND_DATA- Plans including voice (and SMS) in addition to data
Values are
DATAorVOICE_AND_DATA. -
truefor recurring plans such as UK domestic plans -
Billing interval of recurring plans (
MONTHLYfor UK domestic plans),nullfor one-off plansValues are
DAILY,WEEKLY,MONTHLY,YEARLY, or null. -
Hide destination attributes Show destination attributes object
-
Possible values:
MB- MegaByte representationGB- GigaByte representation
Values are
MBorGB. -
Details:
- If
dataValue>= 0 then the plan is capped to that amount of consumable data - If
dataValue== -1 then the plan is unlimited and does not have a cap on consumable data
- If
-
Details:
MINUTES- Minutes representationHOURS- Hours representation
Values are
MINUTESorHOURS. -
Details:
- If
callValue>= 0 then the plan is capped to that amount of consumable call time - If
callValue== -1 then the plan is unlimited and does not have a cap on call time
- If
-
Details:
- If
smsValue>= 0 then the plan is capped to that amount of consumable SMS sent - If
smsValue== -1 then the plan is unlimited and does not have a cap on SMS sent
- If
-
Hide features attributes Show features attributes object
-
Possible values:
HOTSPOT- The plan does support the hotspot functionTOP_UP- The plan does support top up operations3G- The plan and its associated network supports speeds up to 3G4G- The plan and its associated network supports speeds up to 4G5G- The plan and its associated network supports speeds up to 5G
Values are
HOTSPOT,TOP_UP,3G,4G, or5G. -
Values are
UTILITY,BILLING, orNETWORK.
-
-
Hide prices attributes Show prices attributes object
-
The unit amount in minor units (e.g. cents, if supported), represented as a signed integer
-
Indicates the number of decimals in the price for currencies supporting this format or
0for zero-decimal currencies such asJPY. Examples:- A
USDpricevalueof 490 with aminorUnitsExponentof 2 would be $4.90 - A
JPYpricevalueof 775 with aminorUnitsExponentof 0 would be ¥775
- A
-
Present when a valid
discountCodewas applied — the price before discount, in minor units
-
Hide activity attributes Show activity attributes object | null
-
truewhen the Subscription is scheduled to be cancelled atcancelEffectiveDate -
Date a scheduled cancellation takes effect
-
-
-
Missing or invalid access token or
X-App-IdentifierHide response attributes Show response attributes object
-
Your role is not allowed to perform this operation
Hide response attributes Show response attributes object
curl \
--request GET 'https://zim.api.dev.zimconnections.com/orders' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-App-Identifier: $API_KEY"
[
{
"id": "ordr_GMAVA4ISiqfWSG0ArGOzB",
"status": "FULFILLED",
"accountID": "acct_ozxEbkTyvLPhhoglcALXE",
"planID": "plan_guaGulGcrqgTYboPvetgu",
"userID": "user_yf95A86RIkVxau2gzBsjV",
"type": "ONE_OFF",
"createdAt": "2026-10-12T14:39:23.149Z"
}
]
{
"statusCode": 401,
"message": "Unauthorized"
}
{
"statusCode": 403,
"message": "Forbidden resource",
"error": "Forbidden"
}