onOrderAutoRenewCanceled( )

An event that triggers when an order is canceled with effectiveAt as NEXT_PAYMENT_DATE.

The onOrderAutoRenewCanceled() event handler runs when an order's auto-renewal is canceled for the next payment date. The received OrderAutoRenewCanceled object contains information about the order whose auto-renewal is canceled for the next payment date.

The onOrderAutoRenewCanceled() event will not trigger in the following scenarios:

  • If the order was canceled with effectiveAt as IMMEDIATELY.
  • When an order expires by reaching its endDate and was not canceled.

Note: Backend events don't work when previewing your site.

Method Declaration
Copy
Method Parameters
eventOrderAutoRenewCanceledEventRequired

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

Did this help?