Use the Pricing Plans Orders API to manage orders for your 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.
To use APIs to manage your plan orders, first set up your site to:
Accept payments as described in About Accepting Payments.
Offer membership plans as described in About Pricing Plans. When setting up your site to accept pricing plans, define the plans you want to offer using the Dashboard or using the Pricing Plan APIs.
Members can order pricing plans in 2 ways:
Use the Orders API to manage online pricing plan orders. You can:
Actions related to basic pricing plan management are available from the Pricing Plans page in the Dashboard. These actions correspond to the functions 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 your site's Subscriptions page in the Dashboard. Actions available on this page correspond to the functions available in the Orders APIs and the Checkout APIs.
Notes:
Wix pricing plans are 1 type of Wix subscriptions available from the Subscriptions page. For example, the Subscriptions page also includes Wix Stores subscriptions and Wix invoice subscriptions.
Pricing plans can be 1 of 3 different pricing models: singlePaymentForDuration
, singlePaymentUnlimited
, and subscription
. Orders for all pricing plan models are displayed
on the Subscriptions page, not just subscription
type models. See Pricing Models to learn more.
The current user needs to be logged in to perform
plan order functions, such as listCurrentMemberOrders()
, requestCurrentMemberOrderCancellation()
.
To use the Orders API, import orders
from the wix-pricing-plans-frontend
module.
1