Pause Order

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Pauses an order.

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. Can only pause orders with an ACTIVE status.

Use Resume Order to resume a paused order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Learn more about permission scopes.

Event TriggersThis method triggers the following events:
Was this helpful?