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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
function pauseOrder(_id: string): Promise<void>;
Method Parameters
_idstringRequired

Order ID.

JavaScript
import { orders } from "@wix/pricing-plans";

async function pauseOrder(id) {
  const response = await orders.pauseOrder(id);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?