onOrderAutoRenewCanceled( )


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 and effectiveAt is set to NEXT_PAYMENT_DATE.

This webhook is not triggered in the following scenarios:

  • When an order is canceled and effectiveAt is set to IMMEDIATELY. Instead, at the time of cancellation, Order Canceled is triggered.
  • When an order expires at the end of the current payment cycle because it was canceled and effectiveAt was set to NEXT_PAYMENT_DATE. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.

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: OrderAutoRenewCanceledEnvelope): void | Promise<void>

Was this helpful?
Yes
No