eSIM API
POST /orders/with-wallet
Oauth2 & App identifier
application/json

Body

  • planID string

    The Plan ID which is linked to the Order

  • accountID string

    The Account ID linked to this Order. Allows to generate orders OnBehalf of another Account. If omitted this will default to the Account associated with the User making the query.

  • currencyISO string

    The currency ISO for the Order. If omitted, this will default to the preferred currency for the Account.

  • notifyRecipient boolean

    If true, a notification, push / sms or email will be sent to the end User based on the Account preferences.

  • quantity number

    The quantity of Plans to purchase for this Order.

  • usersIDs array[string]

    Optional. A list of User IDs for which the Order is being generated. If omitted, the Order defaults to the User making the request.

  • orderType string

    Optional. Defaults to ONE_OFF when omitted.

    • ONE_OFF - The Order is a one-off purchase
    • TOP_UP - The Order tops up an existing Subscription — subscriptionID must be provided
    • RECURRING - The Order is part of a recurring Subscription

    Values are ONE_OFF, TOP_UP, or RECURRING.

  • subscriptionID string

    Optional. The ID of the Subscription to top up. Required when orderType is TOP_UP, ignored otherwise.

Responses

  • 200 application/json

    Order creation succeeded

    Hide response attributes Show response attributes object
    • id string
    • accountID string
    • planID string
    • userID string
    • createdAt date
    • status string
    • type string
POST /orders/with-wallet 
curl \
 --request POST 'https://zim.api.dev.zimconnections.com/orders/with-wallet' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-App-Identifier: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"planID":"plan_guaGulGcrqgTYboPvetgE","accountID":"acct_ozxEbkTyvLPhhoglcALXE","currencyISO":"USD","notifyRecipient":true,"quantity":1,"usersIDs":["user_ozxEbkTyvLPhhoglcALXR"],"orderType":"ONE_OFF","subscriptionID":"sub_yf95A86RIkVxau2gzBsjV"}'
Request examples 
{
  "planID": "plan_guaGulGcrqgTYboPvetgE",
  "accountID": "acct_ozxEbkTyvLPhhoglcALXE",
  "currencyISO": "USD",
  "notifyRecipient": true,
  "quantity": 1,
  "usersIDs": [
    "user_ozxEbkTyvLPhhoglcALXR"
  ],
  "orderType": "ONE_OFF",
  "subscriptionID": "sub_yf95A86RIkVxau2gzBsjV"
}
Response examples (200) 
{
  "id": "ordr_GMAVA4ISiqfWSG0ArGOzB",
  "accountID": "acct_ozxEbkTyvLPhhoglcALXE",
  "userID": "user_yf95A86RIkVxau2gzBsjV",
  "createdAt": "2026-03-12T14:39:23.149Z",
  "status": "PROCESSING",
  "type": "ONE_OFF"
}