Plan Object


Properties
buyableboolean

Whether customers can currently purchase this plan. If set to false, customer won't be able to buy a plan themselves. In this case a Wix user has to assign the plan through the dashboard.


buyerCanCancelboolean

Whether buyers can cancel their subscription to this plan.


createdDatestringRead-onlyformat date-time

Date and time the plan was created.


currencystringRead-onlyformat CURRENCY

Three-letter currency code in ISO-4217 alphabetic format.


descriptionstringmaxLength 450

Plan description that explains what customers get with this plan.


extendedFieldsExtendedFields

Data extensions. Learn more about extended fields.


formIdstringformat GUID

ID of the form associated with the plan at checkout.


idstringRead-onlyformat GUID

Plan ID.


imageImage

Plan image displayed during checkout and on the site's Plans & Pricing page.


maxPurchasesPerBuyerintegerminimum 0maximum 10

Maximum number of times the same customer can purchase this plan. Use 0 for unlimited purchases or 1 to limit to one purchase per customer.


namestringminLength 1maxLength 50

Plan name displayed to customers.


perksArray <Perk>maxItems 500

List of text snippets describing what the plan offers. For display purposes only.


pricingVariantsArray <PricingVariant>minItems 1maxItems 1

Pricing variants that define different billing and pricing options for this plan. Currently limited to 1 variant per plan.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the plan is updated.


slugstringformat URL_SLUGmaxLength 255

Unique identifier for this plan within the Wix site. If not provided, generated automatically from the plan name.


termsAndConditionsstringmaxLength 3000

Terms and conditions text that customers must agree to when purchasing this plan.


updatedDatestringRead-onlyformat date-time

Date and time the plan was last updated.


visibilitystring

Plan visibility.

Did this help?