Fulfillment Webhook

Sent when an order is processed for a product or plan with webhook fulfillment enabled

Fulfillment webhooks can be sent as either a GET or POST request

All fulfillment webhooks include the following data fields:

object

event_time

string

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

2 validations

p_country

string

The two-letter ISO country code of the customer. Eg: US, GB. See Supported Countries.

1 validation

p_coupon

string

The coupon code that was used on this order

2 validations

p_coupon_savings

string

The amount of savings given by the applied coupon.

1 validation

p_currency

string

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

1 validation

p_earnings

string

The amount credited to your balance. It is returned as a JSON string in the format: {"vendor_id": "earnings_amount"}. The string will contain multiple entries if there is more than one account involved in the purchase (for example a split checkout).

p_order_id

string

The Paddle Order ID for this payment. This can be used to look up the order within your Seller Dashboard.

1 validation

p_paddle_fee

string

The amount of this order that was paid to Paddle as a fee.

1 validation

p_price

string

The price the user paid for this order.

1 validation

p_product_id

string

The dashboard ID of the product purchased in this order.

1 validation

p_quantity

string

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

1 validation

p_sale_gross

string

The total value of the sale (including tax) in the sale currency.

1 validation

p_tax_amount

string

The amount of this order that was paid in tax.

1 validation

p_used_price_override

string

Whether the dashboard price was overridden.

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

quantity

string

This field is deprecated and will be removed in a future update. Please refer to the p_quantity field instead.

1 validation

p_signature

string

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

Custom Fields

You may specify additional custom webhook data fields for each product, either attaching order-specific information or static values.

The marketing_consent field is only included if the customer email has been included.

{email}

string

The email address of the customer.

format: email

{message}

string

The custom message displayed in the checkout.

maxLength: 255

{customer_name}

string

The name of the customer. For card payments, this will return the cardholder name entered by the buyer during the checkout. For PayPal payments, this will return the name from the PayPal account used during the checkout. For all other payment methods where the name is not collected (including Apple Pay and Wire Transfer), we will return the email prefix from the customer’s email address.

{transaction_id}

string

A unique hash representing the transaction.

{checkout_id}

string

The checkout id of the order created.

example: 27835673-chre93c81118fc7-b3092639c1

{static_value}

string

Any fixed string value you wish to include in webhooks for this product.

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: 0, 1