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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

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

Order ID.

Errors

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

Did this help?