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.

The onOrderAutoRenewCanceled() is triggered when an order is canceled and effectiveAt is set to NEXT_PAYMENT_DATE.

The onOrderAutoRenewCanceled() event is not triggered in the following scenarios:

  • When an order is canceled and effectiveAt is set to IMMEDIATELY. At the time of cancellation, onOrderCanceled is triggered instead.
  • When an order expires at the end of the current payment cycle because it was canceled and effectiveAt was set to NEXT_PAYMENT_DATE. At the time of expiration, onOrderCanceled and onOrderEnded are triggered instead.
Method Declaration
Copy
Method Parameters
eventOrderAutoRenewCanceledEvent

Information about the order whose auto-renewal is canceled and metadata for the event.

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?