Introduction

Use the Pricing Plans Orders API to manage orders for pricing plans. The Pricing Plans Orders API provides functionality for managing pricing plan orders created in the Wix Pricing Plans app or using this Wix Pricing Plans API.

Set up orders

To use APIs to manage plan orders, first set up a site to:

• Accept payments as described in About Accepting Payments.

• Offer membership plans as described in About Pricing Plans. When setting up a site to accept pricing plans, define the plans you want to offer using a Wix user's dashboard or using the Pricing Plan APIs.

Manage orders

Site members can order pricing plans in 2 ways:

• Online. Site members order and pay for their plans on a site without manual intervention. This can also be done in backend code.
• Offline. Site members place their order by phone, text, or email. This can only be done in backend code.

Use the Orders API to manage online pricing plan orders. You can:

• List orders for the currently logged-in site member.
• Allow site members to request cancellation of their own orders.

Orders and subscriptions

Actions related to basic pricing plan management are available from the Pricing Plans page in a Wix user's dashboard. These actions correspond to the methods available in the Pricing Plans APIs.

Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. You can see all orders from a site's Subscriptions page in a Wix user's dashboard. Actions available on this page correspond to the methods available in the Orders APIs and the Checkout APIs.

Roles and permissions

The current site visitor needs to be logged in to perform plan order methods, such as listCurrentMemberOrders() or requestCurrentMemberOrderCancellation().

Import the APIs

To use the Orders API, import orders from the wix-pricing-plans-frontend module.