Introduction

Setting up orders

To use APIs to manage your plan orders, first set up your site to:

• Accept payments as described in About Accepting Payments.

• Offer membership plans as described in About Pricing Plans. When setting up your site to accept pricing plans, define the plans you want to offer using the Dashboard or using the Pricing Plan APIs.

Managing orders

Members can order pricing plans in 2 ways:

• Online. Members order and pay for their plans on your site without manual intervention.
• Offline. Members place their order by phone, text, or email. You manually record each stage of the transaction.

Use the Orders API to manage both online and offline pricing plan orders. You can:

• Get a single order or a list of multiple orders.
• Let members get and list their own order(s).
• Cancel members' orders.
• Allow members to cancel their own orders.
• Mark offline orders as paid.
• Manage orders, including pausing, postponing, and resuming them.

Updating the properties of a pricing plan does not affect any current orders of the plan by members. The existing orders retain their existing terms and pricing.

Note: Deprecated Paid Plans APIs are still supported for the following, but we encourage you to migrate to the Pricing Plans APIs instead.

Orders and subscriptions

Actions related to basic pricing plan management are available from the Pricing Plans page in the Dashboard. These actions correspond to the functions available in the Pricing Plans APIs.

Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. You can see all orders from your site's Subscriptions page in the Dashboard. Actions available on this page correspond to the functions available in the Orders APIs and the Checkout APIs.

Notes:

• Wix pricing plans are 1 type of Wix subscriptions available from the Subscriptions page. For example, the Subscriptions page also includes Wix Stores subscriptions and Wix invoice subscriptions.

• Pricing plans can be 1 of 3 different pricing models: singlePaymentForDuration, singlePaymentUnlimited, or subscription. Orders for all pricing plan models are displayed on the Subscriptions page, not just subscription type models. See Pricing Models to learn more.

Roles and permissions

Some functions require that only site visitors with the Manage Pricing Plans and Manage Subscriptions permissions can perform pricing plan order functions. You can override the permissions by setting the function's suppressAuth option to true.

Other functions might require that the site visitor just be logged in.

Importing the APIs

To use the Orders API, import orders from the wix-pricing-plans-backend module.

import {orders} from 'wix-pricing-plans-backend';