onOrderStarted( )

An event that triggers when the start date of a purchased or free order is reached.

The onOrderStarted() event handler runs when an order is started. This means the order's start date is reached and the buyer can start using the plan. The received OrderStartedEvent object contains information about the order that started.

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

Method Declaration
Method Parameters

Information about the order that started and metadata for the event.

Was this helpful?