subscription_cancelled event is fired when an existing customer subscription is cancelled.
Information sent in the payload for a
subscription_cancelled webhook is summarized in the table below.
|alert_id||string||The unique identifier for this Paddle webhook alert. Integer value sent as a string.|
|alert_name||string||The alert name. Default: |
|cancellation_effective_date||string<date>||The date the cancellation should come into effect, taking the customer’s most recent payment into account. The customer should be able to use the service they've subscribed to up until this date.|
|checkout_id||string||The checkout id of the order created.|
|currency||string||The three-letter ISO currency code. For a full list of supported currencies, see our Supported Currencies page.|
|custom_data||string||A JSON encoded string of custom data that was passed into the checkout for this subscription|
|string<email>||The email address of the customer.|
|event_time||string<date-time>||The date and time the event was triggered in UTC (Coordinated Universal Time).|
|marketing_consent||string||The value of this field |
|p_signature||string||This field contains an encrypted token that you can use to verify the request authenticity. See Verifying Webhooks.|
|passthrough||string||This field contains any values that you passed into the checkout using the |
|quantity||string||The number of products or subscription seats sold in the transaction.|
|status||string||This is the current status of the subscription. |
A list of possible values and their meanings can be found under Event Statuses.
|subscription_id||string||This is the unique Subscription ID for this customer’s subscription. You should store this with the customer in your database, as it is needed for making API calls.|
|subscription_plan_id||string||The ID of the Subscription Plan the customer is subscribed to. (This is the value that will change upon plan change).|
|unit_price||string||The price per unit of the subscription.|
|user_id||string||The customer user ID.|