Use the Pricing Plans Checkout API to create online and offline orders for your pricing plans. The Pricing Plans Checkout API provides functionality for creating orders created in the Wix Pricing Plans app or using this Wix Pricing Plans API.
To use APIs for checking out 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.
Use the Checkout APIs to create orders and facilitate payment.
The Checkout API allows you to:
Updating the properties of a pricing plan does not affect any current orders of the plan. The existing orders retain their existing terms and pricing.
Members can order pricing plans in 2 ways:
Online orders are considered drafts until they are paid for. Drafts are not listed
in the Subscriptions dashboard page and are not saved in the Orders
collection. Drafts
are displayed when listing orders with the listOrders()
function.
Offline orders are never considered drafts even if they are not yet paid for. Unlike
online orders, offline orders are immediately listed
in the Subscriptions dashboard page and saved in the Orders
collection.
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
, or subscription
. Orders for all pricing plan models are displayed
on the Subscriptions page, not just subscription
type models. See Pricing Models to learn more.
Some functions require that only site visitors with the Manage Pricing Plans and Manage Subscriptions permissions
can perform pricing plan checkout functions. You can override the permissions by setting the function's suppressAuth
option to true
.
Other functions might require that the site visitor just be logged in.
To use the Checkout API, import checkout
from the wix-pricing-plans-backend
module.
1