Order Canceled
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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 toIMMEDIATELY
, the webhook is triggered immediately when canceled. - If the order is canceled and
effectiveAt
is set toNEXT_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.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Orders
Manage Bookings Services and Settings
Read Orders
Learn more about permission scopes.
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
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.
entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.pricing_plans.v2.order.
slugstring
Event name. Expected canceled.
entityIdstring
ID of the entity associated with the event.
eventTimestringformat date-time
Event timestamp.
triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
originatedFromstring
If present, indicates the action that triggered the event.
actionEventobject
Event information.
Was this helpful?
Yes
No