resumeOrder( )

Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.

Resuming an order causes the following changes:

  • The order status changes to "ACTIVE".
  • The pausePeriods array is updated.
  • The endDate for the order is adjusted to include the pause period.
  • For orders with recurring payments, the payment schedule is restarted.
  • The earliestEndDate is adjusted to include the pause period. (This property is reserved for future use).

To pause an order, call Pause 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 resumeOrder(_id: string): Promise<void>;
Method Parameters
_idstringRequired

Order ID.

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

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

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

Did this help?