Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
By default, this endpoint will retrieve all orders and return them sorted by createdDate
in DESC
, descending order.
sort.fieldName
supports endDate
and createdDate
fields and defaults to ASC
, ascending order.
You can only call this method when authenticated as a Wix app or Wix user identity.
Filter by a buyer's member ID, from the Members API.
Filter by plan IDs, from the Plans API.
Filter by whether or not the auto-renewal of recurring orders was canceled.
Filter by order status.
Filter by payment status.
Number of orders to return. See Sorting and Paging for more information.
Max: 50
Number of orders to skip in the current sort order.
Name of the field to sort by.
Sort order.
Predefined set of fields to return.
Default: If fieldSet
is omitted, no order form submission data is returned.
List of orders.
Object containing paging-related data (number of orders returned, offset).
curl -X GET \
'https://www.wixapis.com/pricing-plans/v2/orders?orderStatuses=CANCELED&orderStatuses=ENDED' \
-H 'Authorization: <AUTH>'
{
"orders": [
{
"id": "982184d9-fd86-43e2-a1e1-37f5b96d2d1c",
"planId": "ab4547ad-b584-4f71-aaba-3e951ef45f2b",
"subscriptionId": "e4424ef6-c256-4bc0-a6e0-c0289faaf4c6",
"buyer": {
"memberId": "805ce40a-9000-464e-85ed-5bb052d8beb7",
"contactId": "805ce40a-9000-464e-85ed-5bb052d8beb7"
},
"priceDetails": {
"subtotal": "0",
"discount": "0",
"total": "0",
"planPrice": "0",
"currency": "EUR",
"singlePaymentUnlimited": true
},
"pricing": {
"singlePaymentUnlimited": true,
"prices": [
{
"duration": {
"cycleFrom": 1
},
"price": {
"subtotal": "0",
"discount": "0",
"total": "0",
"currency": "EUR"
}
}
]
},
"type": "ONLINE",
"status": "CANCELED",
"cancellation": {
"cause": "MEMBER_ACTION",
"effectiveAt": "IMMEDIATELY"
},
"lastPaymentStatus": "NOT_APPLICABLE",
"startDate": "2022-02-03T11:48:30.792Z",
"endDate": "2022-02-07T12:16:04.139Z",
"planName": "Chess course+",
"planDescription": "Beginner",
"planPrice": "0",
"createdDate": "2022-02-03T11:48:30.792Z",
"updatedDate": "2022-02-07T12:16:04.218Z"
},
...
]
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.