resumeOrder( )

Resumes a paused pricing plan order.

The resumeOrder() function returns a Promise that resolves when a paused order is successfully resumed.

For orders with recurring payments, resumeOrder() 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.
  • The earliestEndDate is adjusted to include the pause period. This property is reserved for future use.

The onOrderResumed() and onOrderUpdated() event handlers run when an order is resumed.

Note: Only site visitors with the Manage Pricing Plans and Manage Subscriptions permissions can resume orders. You can override the permissions by setting the function's suppressAuth option to true.

Method Declaration
Copy
Method Parameters
orderIdstringRequired

ID of the order being resumed.

optionsOptions

Options to use when resuming an order.

Was this helpful?
Yes
No