Search.../

onOrderAutoRenewCanceled( )

Developer Preview

Triggered when an order is canceled and effectiveAt is set to NEXT_PAYMENT_DATE.

Description

This webhook is not triggered in the following scenarios:

  • When an order is canceled and effectiveAt is set to IMMEDIATELY. Instead, at the time of cancellation, Order Canceled is triggered.
  • When an order expires at the end of the current payment cycle because it was canceled and effectiveAt was set to NEXT_PAYMENT_DATE. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.

Syntax

function wixPricingPlans_onOrderAutoRenewCanceled(event: OrderAutoRenewCanceledEvent): void

onOrderAutoRenewCanceled Parameters

NAME
TYPE
DESCRIPTION
event
Optional
OrderAutoRenewCanceledEvent

Returns

This function does not return anything.

Return Type:

void

Was this helpful?

onOrderAutoRenewCanceled example

Copy Code
1
2 export function wixPricingPlans_onOrderAutoRenewCanceled(event) {
3 const eventId = event.metadata.id
4 const entityId = event.data.order._id;
5 }
6
7