onOrderEnded( )

Notes:

Triggered when an order ends.

This webhook is triggered:

  • When an order expires at the end of the current payment cycle.
  • When an order is canceled and effectiveAt is set to IMMEDIATELY.
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: OrderEndedEnvelope): void | Promise<void>

Did this help?