Subscription Cancelled

Subscription Cancelled
alert_name
string

The alert name.

Default:
subscription_cancelled
alert_id
string

The unique identifier for this Paddle webhook alert. Integer value sent as a string.

Match pattern:
\d+
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.

Match pattern:
^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$
checkout_id
string

The checkout id of the order created.

Example:
27835673-chre93c81118fc7-b3092639c1
currency
string

The three-letter ISO currency code. Eg: USD, GBP. See Supported Currencies.

Match pattern:
[A-Z]{3}
email
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).

Match pattern:
[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) (2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]
marketing_consent
integer

The value of this field 0 or 1 indicates whether the user has agreed to receive marketing messages from the vendor.

Allowed values:
01
passthrough
string

This field contains any values that you passed into the checkout using the passthrough parameter. See the Pass Parameters documentation for more information.

<= 1000 characters
quantity
string

The number of products or subscription seats sold in the transaction.

Match pattern:
\d+
status
string

This is the current status of the subscription. A list of possible values and their meanings can be found under Event Statuses.

Allowed values:
activetrialingpast_duepauseddeleted
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.

Match pattern:
\d+
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).

Match pattern:
\d+
unit_price
string

The price per unit of the subscription.

Match pattern:
(\d+\.\d{1,2})
user_id
string

The customer user ID.

Match pattern:
\d+
p_signature
string

This field contains an encrypted token that you can use to verify the request authenticity. See Verifying Webhooks.