Deprecated — use POST /v2/orders. Returns only the first Order when several recipients are given.
Body
-
The Plan ID which is linked to the Order
-
Default value is
usd. -
If
true, a notification, push / sms or email will be sent to the end User based on the Account preferences.Default value is
true. -
Optional. Users for which the Order is generated. Defaults to the User making the request.
Not more than
50elements. Maximum length of each is32. -
Values are
ONE_OFForTOP_UP. Default value isONE_OFF. -
Required when
orderTypeisTOP_UP— the Subscription to top up -
Activation date (ISO 8601 or
DD-MM-YYYY), not in the past
POST
/orders/with-wallet
curl \
--request POST 'https://zim.api.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",
"currencyISO": "usd",
"notifyRecipient": true,
"usersIDs": [
"user_ozxEbkTyvLPhhoglcALXR"
],
"orderType": "ONE_OFF",
"subscriptionID": "subs_yf95A86RIkVxau2gzBsjV",
"activationDate": "string"
}'
Request examples
{
"planID": "plan_guaGulGcrqgTYboPvetgE",
"currencyISO": "usd",
"notifyRecipient": true,
"usersIDs": [
"user_ozxEbkTyvLPhhoglcALXR"
],
"orderType": "ONE_OFF",
"subscriptionID": "subs_yf95A86RIkVxau2gzBsjV",
"activationDate": "string"
}
Response examples (201)
{
"id": "ordr_GMAVA4ISiqfWSG0ArGOzB",
"accountID": "acct_ozxEbkTyvLPhhoglcALXE",
"planID": "plan_guaGulGcrqgTYboPvetgu",
"userID": "user_yf95A86RIkVxau2gzBsjV",
"createdAt": "2026-10-27T14:39:23.149Z",
"status": "PROCESSING",
"type": "ONE_OFF"
}
Response examples (400)
{
"statusCode": 400,
"message": [
"property foo should not exist"
],
"error": "Bad Request"
}