Skip to content
You're viewing guides for Paddle Classic, which is no longer available for new signups. Head to developer.paddle.com for Paddle Billing guides.

Invoice sent (Legacy)

{
"type": "object",
"title": "Invoice Sent",
"description": "Identify this event with the HTTP POST parameter `alert_name` with a value of `invoice_sent`",
"properties": {
"alert_name": {
"type": "string",
"default": "invoice_sent",
"description": "The alert name."
},
"alert_id": {
"type": "string",
"title": "Alert ID",
"description": "The unique identifier for this Paddle webhook alert. Integer value sent as a string.",
"pattern": "\\d+"
},
"payment_id": {
"type": "string",
"pattern": "\\d+",
"description": "The unique identifier for this invoice payment. Integer value sent as a string."
},
"amount": {
"type": "string",
"description": "The amount of the sale.",
"pattern": "^\\d+(\\.\\d{1,2})?$"
},
"sale_gross": {
"type": "string",
"description": "The total value of the sale (including tax) in the sale currency.",
"pattern": "^\\d+(\\.\\d{1,2})?$"
},
"term_days": {
"type": "string",
"description": "Number of days from the `invoiced_at` date before it becomes overdue.",
"pattern": "\\d+"
},
"status": {
"type": "string",
"description": "Status of the invoice.",
"enum": ["unpaid"]
},
"purchase_order_number": {
"type": "string",
"description": "Custom order number specified for this invoice.",
"maxLength": 255
},
"invoiced_at": {
"type": "string",
"description": "The date and time the buyer was invoiced at in UTC (Coordinated Universal Time).",
"format": "date-time",
"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]"
},
"currency": {
"type": "string",
"title": "Currency",
"description": "The three-letter ISO currency code. Eg: `USD`, `GBP`. See [Supported Currencies](/reference/platform-parameters/supported-currencies).",
"pattern": "[A-Z]{3}"
},
"product_id": {
"type": "string",
"title": "Product ID",
"description": "The dashboard ID of the product purchased in this order.",
"pattern": "\\d+"
},
"product_name": {
"type": "string",
"description": "The name of the product included in the invoice.",
"maxLength": 200
},
"product_additional_information": {
"type": "string",
"description": "Custom additional information included in the invoice.",
"maxLength": 255
},
"customer_id": {
"type": "string",
"description": "The unique identifier for this customer. Integer value sent as a string.",
"pattern": "\\d+"
},
"customer_name": {
"type": "string",
"description": "The name of the customer this invoice is for."
},
"email": {
"type": "string",
"title": "Email",
"description": "The email address of the customer.",
"format": "email"
},
"customer_vat_number": {
"type": "string",
"description": "The sales tax identifier (VAT number) of the customer this invoice is for."
},
"customer_company_number": {
"type": "string",
"description": "The company number of the customer this invoice is for."
},
"customer_address": {
"type": "string",
"description": "The address of the customer this invoice is for."
},
"customer_city": {
"type": "string",
"description": "The city the customer is from."
},
"customer_state": {
"type": "string",
"description": "The state the customer is from."
},
"customer_zipcode": {
"type": "string",
"description": "The ZIP code of the customer."
},
"country": {
"type": "string",
"title": "Country",
"description": "The two-letter ISO country code of the customer. Eg: `US`, `GB`. See [Supported Countries](/reference/platform-parameters/supported-countries).",
"pattern": "[A-Z]{2}"
},
"contract_id": {
"type": "string",
"description": "The unique identifier for this contract. Integer value sent as a string.",
"pattern": "\\d+"
},
"contract_start_date": {
"type": "string",
"description": "The start date of the contract.",
"format": "date",
"pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$"
},
"contract_end_date": {
"type": "string",
"description": "The end date of the contract.",
"format": "date",
"pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$"
},
"passthrough": {
"type": "string",
"title": "Passthrough",
"description": "This field contains any values that you passed into the checkout using the `passthrough` parameter. See the [Pass Parameters documentation](/guides/checkout/pass-parameters#sending-additional-user-data) for more information.",
"maxLength": 1000
},
"date_created": {
"type": "string",
"description": "The date the contract was created.",
"format": "date",
"pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$"
},
"balance_currency": {
"type": "string",
"title": "Balance Currency",
"description": "The three-letter ISO currency code of the vendor’s account balance at the time of the transaction. Eg: `USD`, `GBP`, `EUR`.",
"pattern": "[A-Z]{3}"
},
"payment_tax": {
"type": "string",
"description": "The amount of this payment that was paid in tax/VAT.",
"pattern": "^\\d+(\\.\\d{1,2})?$"
},
"payment_method": {
"type": "string",
"description": "Payment method used to make the transaction.",
"enum": ["card", "paypal", "apple-pay", "wire-transfer"]
},
"fee": {
"type": "string",
"description": "The fee taken by Paddle for this payment.",
"pattern": "^\\d+(\\.\\d{1,2})?$"
},
"earnings": {
"type": "string",
"description": "The amount of this payment that was credited to your balance.",
"pattern": "^\\d+(\\.\\d{1,2})?$"
},
"p_signature": {
"type": "string",
"title": "P Signature",
"description": "This field contains an encrypted token that you can use to verify the request authenticity. See [Verifying Webhooks](/webhooks/verifying-webhooks)."
},
"event_time": {
"type": "string",
"title": "Event Time",
"description": "The date and time the event was triggered in UTC (Coordinated Universal Time).",
"format": "date-time",
"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]"
}
}
}