onOrderCanceled( )


Developer Preview

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

Note: This method registers a callback function as an event handler. Subscribe your app to the relevant event via the Webhooks page in the Wix Dev Center to enable it. For more information, see Handle Events With Webhooks.

Triggered when an order is canceled.

This webhook is triggered either immediately or at the end of the current payment cycle, as follows:

  • If the order is canceled and effectiveAt is set to IMMEDIATELY, the webhook is triggered immediately when canceled.
  • If the order is canceled and effectiveAt is set to NEXT_PAYMENT_DATE, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
handlerfunction

handler(event: OrderCanceledEnvelope): void | Promise<void>

Was this helpful?
Yes
No