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 orders not yet purchased.
Orders are based on pricing models based on the payment and duration cycles for each plan. Learn more about pricing models (REST|SDK).
Order ID.
ID of the plan purchased with the order, from the Plans API.
ID of the related Wix subscription.
Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. Learn more in a Pricing Plans overview.
Wix Pay order ID.
Provided by Wix whether the order is created online or offline. The field is omitted when the order is free.
The buyer's IDs. Includes memberId and contactId.
Currently, Pricing Plan purchases are limited to members only. contactId is returned,
but a buyer will not be able to purchase a plan without a memberId.
Deprecated. Use pricing instead. This property will be removed on September 30, 2022.
How the order was processed.
Status of the order.
Whether the order will be canceled at the next payment date.
If true, the order status will be CANCELED and the next payment won't be charged. Omitted for single payment orders.
Details about the cancellation of an order.
Only present if the status is CANCELED.
Status of the last payment for the order. Updated automatically for online orders. Updated manually by the site owner for offline orders.
Start date and time for the ordered plan.
Current end date and time for the ordered plan.
endDate may be updated over the course of an order.
If the order is paused, it will have a later endDate once it is resumed.
endDate may also be postponed.
Omitted if the order is valid until canceled and still ACTIVE.
List of periods during which the order is paused.
Free trial period for the order, in days.
Only available for recurring plans.
Earliest end date and time that the plan for the order can expire.
Calculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.
Current payment cycle for the order.
currentCycle will be omitted if the order's status is CANCELED or ENDED, or if the startDate hasn't passed yet.
Plan name at the time of purchase.
Plan description at the time of purchase
Plan price as it was at the moment of order creation.
Date and time the order was created.
Date and time the order was updated.
Information about the form submitted during the plan's checkout.