About the Plans API

The Plan entity includes all the details of plans available on a site. Using the Plans API, you can create and manage plans, change the visibility and availability of a plan for purchase, and get plan statistics. Plans provides a customizable pricing page where customers can view the plan perks, prices and other features including free trials, purchase limitations and more. All plans either have a duration or can be valid until canceled by a customer.

Use the Plans API to:

  • Create & update plans.
  • Get statistics about the plans.
  • Get specific plan information.
  • Arrange display order for plans.
  • Hide or archive plans.

Setting usage limits

Pricing plans can be limited to be purchased only one time by a single customer. By default, customers can make unlimited purchases.

Terminology

  • Plan: A membership plan or package, offering bundles of features or “perks”.
    • A free plan can be purchased free of charge.
    • A one-time plan can be purchased for a single payment.
    • A recurring plan charges the customer on a weekly, monthly or yearly basis for selected duration of time.
  • Primary plans: Plans that are labeled with a ribbon that is customizable in the Wix Pricing Plans UI.
  • Archived plans: Plans that can no longer be purchased or edited, but existing plan holders can still enjoy purchased membership and will continue to be charged until canceled or expired.
  • Hidden plans: Plans that are not currently visible to customers. Hidden plans may still be sold manually to customers.
  • Free trial: A feature allowing the site owner to test out the perks of the plan for a selected amount of days before the first charge. Relevant for recurring plans.
  • Plan Policy: The definition of terms and conditions for the customer. Plan policy can be displayed per plan on the Wix Pricing Plans checkout page.
Did this help?