Subscription Updated

Fired when the plan, price, quantity, status of an existing subscription changes, or if the payment date is rescheduled manually.

object

Identify this event with the HTTP POST parameter alert_name with a value of subscription_updated

alert_name

string

1 validation

alert_id

string

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

1 validation

cancel_url

string

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.

2 validations

checkout_id

string

The checkout id of the order created.

1 validation

string

The email address of the customer.

1 validation

event_time

string

The date and time the event was triggered in UTC (Coordinated Universal Time).

2 validations

marketing_consent

string

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

1 validation

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.

1 validation

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.

1 validation

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.

1 validation

next_bill_date

string

The date the next payment is due on this subscription.

2 validations

old_price

string

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

1 validation

old_quantity

string

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

1 validation

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.

1 validation

currency

string

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

1 validation

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.

1 validation

status

string

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

1 validation

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.

1 validation

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).

1 validation

user_id

string

The customer user id.

1 validation

update_url

string

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.

2 validations

old_next_bill_date

string

The next bill date before the subscription was updated.

2 validations

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.

1 validation

old_subscription_plan_id

string

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

1 validation

paused_at

string

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

2 validations

paused_from

string

The date when the subscription payment is paused.

2 validations

paused_reason

string

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

1 validation

p_signature

string

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