Subscription Updated

Subscription Updated
alert_name
string

The alert name.

Default:
subscription_updated
alert_id
string

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

Match pattern:
\d+
cancel_url
string<uri>

A URL of the 'Cancel Subscription' page. See this documentation on cancelation URLs. You should store this URL along with the subscribed customer in your database.

<= 200 characters
checkout_id
string

The checkout id of the order created.

Example:
27835673-chre93c81118fc7-b3092639c1
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
new_price
string

The new total recurring price of the subscription. Please note that this will only be returned if the subscription has quantity enabled. Decimal sent as a string.

Match pattern:
(\d+\.\d{1,3})
new_quantity
string

The new quantity applied to a quantity enabled subscription. Please note that this will only be returned if the subscription has quantity enabled.

Match pattern:
\d+
new_unit_price
string

The new price per unit of the subscription. Please note that this will only be returned if the subscription has quantity enabled. Decimal sent as a string.

Match pattern:
(\d+\.\d{1,2})
next_bill_date
string<date>

The date the next payment is due on this subscription.

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

The previous total recurring price of the subscription. Decimal sent as a string.

Match pattern:
(\d+\.\d{1,3})
old_quantity
string

The previous quantity applied to the subscription. Please note that this will only be returned if the subscription has quantity enabled.

Match pattern:
\d+
old_unit_price
string

The previous price per unit of the subscription. Please note that this will only be returned if the subscription has quantity enabled. Decimal sent as a string.

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

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

Match pattern:
[A-Z]{3}
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
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+
user_id
string

The customer user ID.

Match pattern:
\d+
update_url
string<uri>

A URL of the ‘Update Payment Details’ page. See this documentation on update URLs. You should store this URL along with the subscribed customer in your database.

<= 200 characters
old_next_bill_date
string<date>

The next bill date before the subscription was updated.

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

The subscription status before the subscription was updated. A list of possible values and their meanings can be found under Event Statuses.

Allowed values:
activetrialingpast_duepauseddeleted
old_subscription_plan_id
string

The ID of the subscription plan before the subscription was updated.

Match pattern:
\d+
paused_at
string<date-time>

The date and time when the subscription was requested to be paused. The subscription will be paused on the paused_from date.

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]
paused_from
string<date-time>

The date when the subscription payment is paused. The customer should be able to use the service they’ve subscribed to up until this date.

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]
paused_reason
string

The reason why the subscription was paused. For example, delinquent if the payment failed and the rule specified in the recover settings was to pause the subscription.

Allowed values:
delinquentvoluntary
p_signature
string

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