Plan Object


Properties
idstringRead-onlyformat GUID

Plan ID.


revisionstringRead-onlyformat int64

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


createdDatestringRead-onlyformat date-time

Date and time the plan was created.


updatedDatestringRead-onlyformat date-time

Date and time the plan was last updated.


namestringminLength 1maxLength 50

Plan name displayed to customers.


descriptionstringmaxLength 450

Plan description that explains what customers get with this plan.


imageImage

Visual information representing the plan.


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.


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.


pricingVariantsArray <PricingVariant>minItems 1maxItems 1

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


perksArray <Perk>maxItems 500

List of benefits or features included with this plan.


visibilitystring

Plan visibility.


buyableboolean

Whether customers can currently purchase this plan.


formIdstringformat GUID

ID of the form associated with the plan at checkout.


buyerCanCancelboolean

Whether the customer is allowed to cancel their plan.


currencystringRead-onlyformat CURRENCY

Payment currency.


extendedFieldsExtendedFields

Data extensions. Learn more about extended fields.

Did this help?