Using the Pricing Plans API, you can build a customized membership plan experience.
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 with either the Pricing Plans app or the Pricing Plans APIs.
When plans are set up, you can use the API to:
There are two flows for setting up pricing plans: Direct purchases and customized purchases.
Note: To work with the Pricing Plans API, you need to publish your site.
Direct ordering mirrors the ordering of a plan using the Pricing Plans app.
For standard pricing plan processing, call the startOnlinePurchase()
function.
The following outlines the steps in a direct order lifecycle:
startOnlinePurchase()
function to handle all stages of buying the plan (selecting, ordering, and payment):
wixPayStatus
is Successful
.wixPayStatus
is Pending
and the order's status
is DRAFT
. The site member fills in contact
details and selects a payment method. Once payment is completed, the wixPayStatus
is Successful
and the order's status
is ACTIVE
.onPlanPurchased()
event.This flow lets buyers (logged-in site members) order and pay for a plan using a customized flow. You customize the entire process of selecting, requesting, and paying for a plan. You can add elements, such as confirmation lightboxes and forms, to customize the buyer's experience.
To let the buyer order a plan, call the createOnlineOrder()
function.
The following outlines the steps for customizing the pricing plan purchase:
createOnlineOrder()
function to handle the initial order of the plan.onOrderPurchased()
event.For ordering pricing plans, import wixPricingPlansFrontend
from the wix-pricing-plans-frontend
module.
1