Search.../
  1. REST
Generate a test token to explore our APIs

Paid Plan Auto Renewal Cancelled Webhook

When you sign up for the Paid Plan Auto-Renewal Cancelled webhook, you will receive this notification when a user cancels their paid plan. (The user will remain a paying user until the plan expires)

Event 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

NAME
TYPE
DESCRIPTION
operationTimeStamp
string

Date and time of auto-renewal cancellation.

vendorProductId
string

Current app plan.

cycle
string

Supported values: NO_CYCLE, MONTHLY, YEARLY, ONE_TIME.

Current payment cycle.

cancelReason
string

Supported values: UNKNOWN_CANCELLATION_TYPE_ERROR_STATE, USER_CANCEL, FAILED_PAYMENT, TRANSFER_CANCELLATION_REASON. Reason provided by app for cancellation (if relevant).

userReason
string

Reason provided by site owner for cancellation (if relevant).

subscriptionCancellationType
string

Cancellation type.

Was this helpful?

The data payload will include the following as an encoded JWT:

Event Body

json

1{
2 "data": {
3 "eventType": "<event-type>",
4 "instanceId": "<app-instance-id>",
5 "data": "<stringified-JSON>"
6 }
7}

The parsed data will include:

Sample Data

json

1{
2 "data" : "{\"operationTimeStamp\":\"2019-12-09T07:55:18.356Z\",\"vendorProductId\":\"e8f429d4-0a6a-468f-8044-87f519a53202\",\"cycle\":\"MONTHLY\",\"cancelReason\":\"USER_CANCEL\",\"userReason\":\"Cancel reason: No reason chosen\",\"subscriptionCancellationType\":\"AT_END_OF_PERIOD\"}",
3 "instanceId" : "8e9d6b70-6eb9-4ab3-a62d-e033063e2f05",
4 "eventType" : "PaidPlanAutoRenewalCancelled"
5}