pauseOrder( )


Pauses an order. Calling this method changes the order status to "PAUSED" and updates the pausePeriods array.

Only orders with status: ACTIVE can be paused. For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused. Pausing an order affects the end date of the order by adding the time the order is paused to the endDate. The endDate and the earliestEndDate for the order are adjusted to include the pause period when the order is resumed.

To resume a paused order, call Resume Order.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Order ID.

Did this help?