Invoice Paid (Legacy)

Fired when a manual invoice has been successfully paid by a customer.

Information on this page is for the legacy version of Manual Invoicing. For the latest version, click here.

Invoice Paid

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

alert_name

string

The alert name.

Default:

invoice_paid

alert_id

string

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

Match pattern:

\d+

payment_id

string

The unique identifier for this invoice payment. Integer value sent as a string.

Match pattern:

\d+

amount

string

The amount of the sale.

Match pattern:

^\d+(\.\d{1,2})?$

sale_gross

string

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

Match pattern:

^\d+(\.\d{1,2})?$

term_days

string

Number of days from the invoiced_at date before it becomes overdue.

Match pattern:

\d+

status

string

Status of the invoice.

Allowed value:

paid

purchase_order_number

string

Custom order number specified for this invoice.

<= 255 characters

invoiced_at

string<date-time>

The date and time the buyer was invoiced at 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]

currency

string

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

Match pattern:

[A-Z]{3}

product_id

string

The dashboard ID of the product purchased in this order.

Match pattern:

\d+

product_name

string

The name of the product included in the invoice.

<= 200 characters

product_additional_information

string

Custom additional information included in the invoice.

<= 255 characters

customer_id

string

The unique identifier for this customer. Integer value sent as a string.

Match pattern:

\d+

customer_name

string

The name of the customer this invoice is for.

string<email>

The email address of the customer.

customer_vat_number

string

The sales tax identifier (VAT number) of the customer this invoice is for.

customer_company_number

string

The company number of the customer this invoice is for.

customer_address

string

The address of the customer this invoice is for.

customer_city

string

The city the customer is from.

customer_state

string

The state the customer is from.

customer_zipcode

string

The ZIP code of the customer.

country

string

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

Match pattern:

[A-Z]{2}

contract_id

string

The unique identifier for this contract. Integer value sent as a string.

Match pattern:

\d+

contract_start_date

string<date>

The start date of the contract.

Match pattern:

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

contract_end_date

string<date>

The end date of the contract.

Match pattern:

^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[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

date_created

string<date>

The date the contract was created.

Match pattern:

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

balance_currency

string

The three-letter ISO currency code of the vendor’s account balance at the time of the transaction. Eg: USD, GBP, EUR.

Match pattern:

[A-Z]{3}

payment_tax

string

The amount of this payment that was paid in tax/VAT.

Match pattern:

^\d+(\.\d{1,2})?$

payment_method

string

Payment method used to make the transaction.

Allowed values:

cardpaypalapple-paywire-transfer

fee

string

The fee taken by Paddle for this payment.

Match pattern:

^\d+(\.\d{1,2})?$

earnings

string

The amount of this payment that was credited to your balance.

Match pattern:

^\d+(\.\d{1,2})?$

balance_earnings

string

The amount credited to your balance in your default currency.

Match pattern:

^\d+(\.\d{1,2})?$

balance_fee

string

The fees taken by Paddle in your dashboard balance currency.

Match pattern:

^\d+(\.\d{1,2})?$

balance_tax

string

The amount paid in tax in your dashboard balance currency.

Match pattern:

^\d+(\.\d{1,2})?$

balance_gross

string

The sale value in your dashboard balance currency.

Match pattern:

^\d+(\.\d{1,2})?$

date_reconciled

string<date>

The date the payment was reconciled on.

Match pattern:

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

p_signature

string

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

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]