resumeOrder( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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).
Permission Scopes
For app development, you must have one of the following permission scopes:Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired
Order ID.
Was this helpful?
Yes
No