listOrders( )

Lists pricing plan orders.

The listOrders() function returns a Promise that resolves to a list of up to 50 pricing plan orders. You can specify options for filtering, sorting, and paginating the results.

This function returns the orders on the site. To list orders for the current member only, see the frontend listCurrentMemberOrders function.

Note: Only site visitors with the Manage Pricing Plans and Manage Subscriptions permissions can list orders. You can override the permissions by setting the function's suppressAuth option to true.

Method Declaration
Copy
Method Parameters
filtersFilterOptions

Filter options for limiting which orders are listed.

sortingSortingOptions

Sorting options, such as by which property and in which direction.

pagingPaginationOptions

Pagination options, such as how many results are listed at a time.

optionsOptions

Options to use when listing orders.

Returns
Return Type:Promise<Array<Order>>
Was this helpful?
Yes
No