Filter and Sort

Select endpoints allow sorting results by field. Use "order": "ASC" to sort results in ascending order, and "order": "DESC" to sort in descending order.

For example, to sort plans by created date in descending order:

Copy
1
"sort": { "fieldName": "createdDate", "order": "DESC" }

Refer to the following tables to check which fields support sorting.

Query Public Plans

FieldDescriptionQuery Filter OperatorsSorting
idPlan ID$eq, $ne, $hasSome
primaryWhether the plan is marked as primary, and highlighted in the site with a custom ribbon$eq, $neAllowed
slugURL-friendly version of the plan name. Unique across all plans in the same site$eq, $ne, $startsWith, $endsWith, $containsAllowed
createdDateDate plan was created$eq, $ne, $gt, $ge, $lt, $le, $betweenAllowed
updatedDateDate plan was updated$eq, $ne, $gt, $ge, $lt, $le, $betweenAllowed
Was this helpful?
Yes
No

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.
Was this helpful?
Yes
No

Plan Object

Properties
idstringRead-onlyformat GUID

Plan ID.


namestringminLength 1

Plan name.


descriptionstring

Plan description.


perksobject

What is included with this plan (e.g., 1 weekly entrance to a specific class).


pricingobject

Plan price, payment schedule, and expiration.


publicboolean

Whether the plan is public (visible to site visitors and members).


archivedbooleanRead-only

Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.


primarybooleanRead-only

Whether the plan is marked as primary.


hasOrdersbooleanRead-only

Whether the plan has any orders (including pending and unpaid orders).


createdDatestringRead-onlyformat date-time

Date plan was created.


updatedDatestringRead-onlyformat date-time

Date plan was last updated.


slugstringRead-onlyminLength 1

URL-friendly version of plan name. Unique across all plans in the same site.


maxPurchasesPerBuyerintegerminimum 0maximum 1format int32

Number of times the same buyer can purchase the plan. Currently limited to support:

  • Empty value or a value of 0, meaning no limitation.
  • Value of 1, meaning limited to one purchase per buyer.

allowFutureStartDateboolean

Whether the buyer can start the plan at a later date. Defaults to false.


buyerCanCancelboolean

Whether the buyer is allowed to cancel their plan. Defaults to false.


termsAndConditionsstringmaxLength 3000

Any terms and conditions that apply to the plan. This information will be displayed during checkout.


formIdstringformat GUID

ID of the form associated with the plan at checkout.

Learn more about forms.

Was this helpful?
Yes
No

GetList Public Plans

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 public pricing plans.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Orders
Read Pricing Plans
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/pricing-plans/v2/plans/public

Was this helpful?
Yes
No

PostQuery Public Plans

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 1,000 public pricing plans, given the provided pagination, sorting, and filtering.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Orders
Read Pricing Plans
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/plans/public/query

Was this helpful?
Yes
No

GetGet Plan

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a pricing plan by ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Pricing Plans
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/pricing-plans/v2/plans/{id}

Was this helpful?
Yes
No

GetList Plans

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans).

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Pricing Plans
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/pricing-plans/v2/plans

Was this helpful?
Yes
No

PostCreate Plan

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a pricing plan.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Pricing Plans
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/plans

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet Plan Stats

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Gets statistics about the pricing plans. Currently providing only the total number of pricing plans.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Pricing Plans
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/pricing-plans/v2/plans/stats

Was this helpful?
Yes
No

PatchUpdate Plan

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a pricing plan. Updating a plan does not impact existing orders made for the plan. All orders keep the details of the original plan that was active at the time of purchase.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Pricing Plans
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/pricing-plans/v2/plans/{plan.id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PutSet Plan Visibility

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sets visibility for pricing plans. Visible plans are considered public plans. By default, pricing plans are public, meaning they are visible. Plans can be hidden so that site members and visitors cannot choose them. As opposed to archiving, setting visibility can be reversed. This means that a public plan can be hidden, and a hidden plan can be made public (visible). (An archived plan always remains archived and cannot be made active again.) Changing a plan’s visibility does not impact existing orders for the plan. All orders for hidden plans are still active and keep their perks.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Pricing Plans
Learn more about permission scopes.
Endpoint
PUT
https://www.wixapis.com/pricing-plans/v2/plans/{id}/visibility

Was this helpful?
Yes
No

PostMake Plan Primary

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Marks a pricing plan as the primary pricing plan. When viewing pricing plans on the site, the primary plan is highlighted with a customizable ribbon.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Pricing Plans
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/plans/{id}/make-primary

Was this helpful?
Yes
No

PostClear Primary

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sets all pricing plans as not primary. When viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Pricing Plans
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/plans/clear-primary

Was this helpful?
Yes
No

PostArchive Plan

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Archives a single plan. When a plan is archived, it is no longer visible as a public plan that can be chosen by site members or visitors. Archived plans cannot be purchased. An archived plan cannot be made active again. Plan archiving does not impact existing orders made for the plan. All orders for the plan are still active and keep their perks. Site owners can see archived plans in the Dashboard under Pricing Plans -> Archived Plans.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Pricing Plans
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/plans/{id}/archive

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostArrange Plans

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Changes the display order of the plans on the site. To rearrange the order of the plans, provide a list of plan IDs in the desired order. Include all public and hidden plans in the list you provide. Make sure to provide all non-archived plan IDs to avoid unpredictable results

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Pricing Plans
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/pricing-plans/v2/plans/arrange

Was this helpful?
Yes
No

Plan Updated

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An event that is triggered when a pricing plan is updated.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.plan.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventobject

Event information.

Was this helpful?
Yes
No

Plan Created

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An event that is triggered when a pricing plan is created.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.plan.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventobject

Event information.

Was this helpful?
Yes
No

Plan Archived

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

An event that is triggered when a pricing plan is archived.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.plan.


slugstring

Event name. Expected plan_archived.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


actionEventobject

Event information.

Was this helpful?
Yes
No