An event that triggers when an order is created.
The onOrderCreated()
event handler runs when an order is created.
The received OrderCreatedEvent
object contains information about the created order.
This event handler runs for both online orders and offline orders.
Note: Backend events don't work when previewing your site.
function onOrderCreated(event: OrderCreatedEvent): void;
Information about the created order and metadata for the event.
// Place this code in the events.js file
// of your site's Backend section.
// Add the file if it doesn't exist.
export function wixPricingPlans_onOrderCreated(event) {
const orderId = event.entity._id;
const eventId = event.metadata.id;
const eventTime = event.metadata.eventTime;
}
/* Full event object:
* {
* "metadata": {
* "id": "b879decf-c5b2-42e0-8066-03643691686b",
* "entityId": "d98900ac-a043-4930-b602-626dc00c4089",
* "eventTime": "2022-07-26T14:16:15.845649Z",
* "triggeredByAnonymizeRequest": false
* },
* "entity": {
* "_id": "d98900ac-a043-4930-b602-626dc00c4089",
* "planId": "099e2c86-3b7e-4477-8c27-f77402b8cceb",
* "subscriptionId": "3cc49b37-64e2-4b7f-aa87-e05e2729e41c",
* "wixPayOrderId": "d7941e1f-c7b9-40bb-a31c-2165fd582087",
* "buyer": {
* "memberId": "ea3d74df-b7dc-4ca1-a7c9-c416b9017a86",
* "contactId":"ea3d74df-b7dc-4ca1-a7c9-c416b9017a86"
* },
* "priceDetails": {
* "subtotal": "74.99",
* "discount": "0",
* "total": "74.99",
* "planPrice": "74.99",
* "currency": "EUR",
* "subscription": {
* "cycleDuration": {
* "count": 1,
* "unit":"MONTH"
* },
* "cycleCount": 3
* }},
* "pricing": {
* "subscription": {
* "cycleDuration": {
* "count": 1,
* "unit":"MONTH"
* },
* "cycleCount": 3
* },
* "prices": [{
* "duration": {
* "cycleFrom": 1,
* "numberOfCycles": 3
* },
* "price": {
* "subtotal": "74.99",
* "discount": "0",
* "total": "74.99",
* "currency": "EUR"
* }}]},
* "type": "OFFLINE",
* "orderMethod": "UNKNOWN",
* "status": "ACTIVE",
* "autoRenewCanceled": false,
* "lastPaymentStatus": "PAID",
* "startDate": "2022-07-26T14:16:15.194Z",
* "endDate": "2022-10-26T14:16:15.194Z",
* "pausePeriods": [],
* "earliestEndDate": "2022-10-26T14:16:15.194Z",
* "currentCycle": {
* "index": 1,
* "startedDate": "2022-07-26T14:16:15.194Z",
* "endedDate": "2022-08-26T14:16:15.194Z"
* },
* "planName": "Platinum Pro",
* "planDescription": "",
* "planPrice": "74.99",
* "_createdDate": "2022-07-26T14:16:15.194Z",
* "_updatedDate": "2022-07-26T14:16:15.194Z"
* }
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.