onOrderCycleStarted( )

An event that triggers at the start of each payment cycle for online orders.

The onOrderCycleStarted() event handler runs when an order's payment cycle is triggered. The received OrderCycleStarted object contains information about the order whose cycle is triggered.

This event handler runs when:

  • An online order starts, either at the current or a future date.
  • When a new payment cycle starts in an existing order.

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

Method Declaration
Method Parameters

Information about the order whose payment cycle started and metadata for the event.

Was this helpful?