Pricing Plans

Information about the pricing plan.

Creates a pricing plan.

Retrieves a pricing plan by ID.

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

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

Retrieves a list of up to 100 public pricing plans.

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

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 ...

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.

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

Sets visibility for pricing plans. Visible plans are considered public plans. By default, pricing plans are public, meaning they are visible. Plans can be ...

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 ...

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 ...

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

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

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

An order object includes all of the details related to the purchase of a Pricing Plan. You can manage existing orders, create offline orders, and preview ...

Creates an order for a buyer who purchased the plan with an offline transaction. An offline order is handled off of the Wix site and is marked as offline in ...

Performs a dry run of a purchase and provides an order preview. The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an ...

Retrieves an order by ID.

Retrieves a plan's pricing. The price preview uses the same logic as purchasing a plan, but the preview is not saved. Tax is only applied if the site has it ...

Retrieves a list of orders and details, given the provided sorting and filtering. By default, this endpoint will retrieve all orders and return them sorted by ...

Marks an offline order as paid. Note: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid.

Extends the duration of a pricing plan order by postponing the order's endDate. New endDate must be later than the order's current endDate. Can't postpone ...

Pauses an order. For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused. Pausing an order ...

Resumes a paused order. Updates endDate by adding the time the plan was paused. For orders with recurring payments, it also restarts the payment schedule. Use ...

Cancels an existing order. For orders with recurring payments, a cancellation can be set to occur either IMMEDIATELY or at the NEXTPAYMENTDATE. For orders with ...

Retrieves an order by ID.

Returns orders for currently logged in member.

Triggered when an order is created.

Triggered when an order is purchased. This webhook is triggered for any of the following events: Order is paid in full. At least 1 order cycle payment is paid ...

Triggered when an order reaches its startDate. Applies to both purchased and free orders.

Triggered at the start of a new payment cycle for an existing order. This webhook is not triggered at the initial start of an offline order.

Triggered when an offline order is marked as paid.

Triggered when an order's endDate is postponed.

Triggered when an order is paused.

Triggered when a paused order is resumed.

Triggered when an order is canceled. This webhook is triggered either immediately or at the end of the current payment cycle, as follows: If the order is ...

Triggered when an order is canceled and effectiveAt is set to NEXTPAYMENTDATE. This webhook is not triggered in the following scenarios: When an order is ...

Triggered when an order ends. This webhook is triggered: When an order expires at the end of the current payment cycle. When an order is canceled and ...

Triggered when an order is updated. This is a general webhook that is triggered when any update is made to an order. More specific webhooks are also triggered ...