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.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function pauseOrder(_id: string): Promise<void>;Order ID.
import { orders } from "wix-pricing-plans.v2";
import { elevate } from "wix-auth";
/* Sample _id value: '9af3cbe6-fe27-4fdb-a0b0-892289b03d22' */
const elevatedPauseOrder = elevate(orders.pauseOrder);
export async function myPauseOrderFunction(_id) {
try {
await elevatedPauseOrder(_id);
return;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to void */This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.