Order Canceled

Triggered when an order is canceled.

This webhook is triggered either immediately or at the end of the current payment cycle, as follows:

  • If the order is canceled and effectiveAt is set to IMMEDIATELY, the webhook is triggered immediately when canceled.
  • If the order is canceled and effectiveAt is set to NEXT_PAYMENT_DATE, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
Permissions
Read Orders
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
actionEventActionEvent

Event information.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

idstring

Unique event ID. Allows clients to ignore duplicate events.

originatedFromstring

If present, indicates the action that triggered the event.

slugstring

Event name. Expected canceled.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation compliance, such as GDPR.


Did this help?