onOrderAutoRenewCanceled( )

Notes:

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.
Permissions
Manage Orders
Manage plans and orders of Pricing Plans
Read Orders
Manage Events
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
handlerfunction

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

Did this help?