\n Developer Preview\n
\n APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.\n

\n\n \n\nWix Pricing Plans events are fired in your site's backend when certain events occur with plans. You can write event handlers that react to these events. Event handler functions receive data that corresponds to the event that has occurred. Use event handlers to create custom responses to pricing plan events.\n\n> **Note:** Backend events don't work when previewing your site.\n\nTo add a pricing plans event handler, add an **events.js** file to the **Backend** section of your site if one does not already exist. All event handler functions for your\nsite are defined in this file.\n\nEvent handler functions are defined using the following pattern:\n```javascript\nexport function _(event) { }\n```\n\nFor example, an event handler that handles pricing plan updates looks like this:\n```javascript\nexport function wixPricingPlans_onPlanUpdated(event) { }\n```\n\n### Order Events and Corresponding Statuses\n\nAs an order progresses through its lifecycle from order creation until\norder completion, various events get triggered. The order's status is\nupdated accordingly. \n\nFor example, the following describes the events and statuses for \nan online, recurring order:\n\n| Timeline of Events | Events Triggered | Order Status |\n|----------------------------------------|-------------------------------------|--------------|\n| 1) Online, recurring order created | orderCreated | DRAFT |\n| 2) Payment arranged, start date later | orderPurchased | PENDING |\n| 3) Start date arrives | orderStarted, orderCycleStarted | ACTIVE |\n| 4) Next cycle arrives | orderCycleStarted | ACTIVE |\n| 5) Last cycle finishes | orderEnded | ENDED |\n\nThe following flowchart details order events and statuses. \n\n![Order Events](orderEvents.png)","displayName":"Introduction","slugifyName":"introduction","fqn":"Introduction23"}],"namespaces":[],"builderTypes":[],"properties":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.44"}}

onOrderCycleStarted( )