Transaction reports

Generate detailed reports about revenue received, past due invoices, draft and issued invoices, and canceled transactions.

Transactions capture and calculate revenue for both checkouts and invoices. They hold information about a customer purchase.

You can generate reports through the dashboard or via the API.

Report filters

When generating transaction reports, you can filter by:

FieldDescription
Updated dateThe date a transaction was last modified. Matches entities modified on or after the start date and before the end date.
Status

The current status of the transaction.

  • Completed: Transaction is completed. Payment collected successfully and fully processed.
  • Paid: Transaction is fully paid, but hasn't yet been processed internally.
  • Draft: Transaction is missing required fields. Typically the first stage of a checkout before customer details are captured.
  • Ready: Transaction has all the required fields to be marked as billed or completed.
  • Billed: Transaction has been updated to billed. Billed transactions get an invoice number and are considered a legal record. They can't be changed. Typically used as part of an invoice workflow.
  • Past due: Transaction is past due. Occurs for automatically-collected transactions when the related subscription is in dunning, and for manually-collected transactions when payment terms have elapsed.
  • Canceled: Transaction has been updated to canceled. If an invoice, it's no longer due.
Origin

Where or why the transaction was created.

  • Created via the API: Transaction created via the Paddle API.
  • Created via the checkout (web): Transaction created automatically by Paddle.js for a checkout.
  • Scheduled subscription renewal: Transaction created automatically by Paddle as a result of a subscription renewal.
  • One-time subscription charge: Transaction created automatically by Paddle as a result of a one-time charge for a subscription.
  • Subscription update: Transaction created automatically by Paddle as a result of an update to a subscription.
  • Payment method update: Transaction created automatically as part of updating a payment method. May be a zero value transaction.
CurrencyThe currency of the transaction.
Collection mode

How the customer has been asked to pay.

  • All: Show both modes.
  • Manual: Payment is collected manually. Customers are sent an invoice with payment terms and can make a payment offline or using a checkout.
  • Auto: Payment is collected automatically using a checkout initially, then using a payment method on file.

Report columns

Column headings on transaction reports mirror fields in the Paddle API. Data is provided in the following columns:

idstring

Unique Paddle ID for this transaction entity, prefixed with txn_.

statusstring

Status of this transaction.

invoice_numberstring or null

Invoice number for this transaction. Automatically generated by Paddle when you mark a transaction as billed where collection_mode is manual.

customer_idstring or null

Paddle ID of the customer that this transaction is for, prefixed with ctm_.

customer_emailstring<email>

Email address for the customer that this transaction is for.

address_idstring or null

Paddle ID of the address that this transaction is for, prefixed with add_.

customer_country_codestring

Supported two-letter ISO 3166-1 alpha-2 country code of the address that this transaction is for.

business_idstring or null

Paddle ID of the business that this transaction is for, prefixed with biz_.

business_namestring or null

Name of the business that this transaction is for.

price_id_liststring

Comma-separated list of price IDs on this transaction.

discount_id_liststring or null

Comma-separated list of discount IDs on this transaction.

subscription_idstring or null

Paddle ID of the subscription that this transaction is for, prefixed with sub_.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

billed_atstring<date-time> or null

RFC 3339 datetime string of when this transaction was marked as billed. null for transactions that are not billed or completed.

payment_captured_atstring<date-time> or null

RFC 3339 datetime string of when payment was last captured for this transaction.

balance_updated_atstring<date-time> or null

RFC 3339 datetime string of when the balance for this transaction was last updated.

completed_atstring<date-time> or null

RFC 3339 datetime string of when this transaction was marked as completed. null for transactions that are not completed.

payment_methodstring

Type of payment method used for the last payment attempt for this transaction.

originstring

How this transaction was created.

collection_modestring

How payment is collected for this transaction. automatic for checkout, manual for invoices.

custom_dataobject

Your own structured key-value data.

payment_terms_frequencyinteger or null

Amount of time for the payment terms set for this transaction. Only present for manually-collected transactions.

payment_terms_intervalstring or null

Unit of time for the payment terms set for this transaction. Only present for manually-collected transactions.

billing_period_starts_atstring<date-time> or null

RFC 3339 datetime string of when the billing period for this transaction starts.

billing_period_ends_atstring<date-time> or null

RFC 3339 datetime string of when the billing period for this transaction ends.

additional_informationstring or null

Notes or other information included on the invoice document generated for this transaction. Only present for manually-collected transactions.

purchase_order_numberstring or null

Customer purchase order number. Only present for manually-collected transactions.

checkout_enabledboolean or null

Whether the related transaction may be paid using a Paddle Checkout. Only present for manually-collected transactions.

currency_codestring

Supported three-letter ISO 4217 currency code for this transaction.

subtotalstring

Subtotal before discount, tax, and deductions in the transaction currency. If an item, unit price multiplied by quantity.

discountstring

Total discount as a result of any discounts applied in the transaction currency.

taxstring

Total tax on the subtotal in the transaction currency.

totalstring

Total after discount and tax in the transaction currency.

creditstring

Total credit applied to this transaction. This includes credits applied using a customer's credit balance and adjustments to a billed transaction.

grand_totalstring

Total due on a transaction after credits but before any payments in the transaction currency.

paddle_feestring or null

Total fee taken by Paddle for this transaction in the transaction currency. null until the transaction is completed and the fee is processed.

earningsstring or null

Total earnings for this transaction in the transaction currency . This is the total minus the Paddle fee. null until the transaction is completed and the fee is processed.

balance_currency_codestring

Three-letter ISO 4217 currency code of your balance currency. If your primary currency has changed, this reflects the primary currency at the time the transaction was billed.

transaction_to_balance_currency_exchange_ratestring

Exchange rate used to convert between the transaction currency to your balance currency. 1.0 if currencies match.

balance_currency_subtotal_added_discountstring or null

Total before tax and fees in your balance currency.

balance_currency_discountstring or null

Total discount as a result of any discounts applied in your balance currency.

balance_currency_taxstring or null

Total tax on the subtotal in your balance currency.

balance_currency_totalstring or null

Total after discount and tax in your balance currency.

balance_currency_paddle_feestring or null

Total fee taken by Paddle for this transaction in your balance currency. null until the transaction is completed and the fee is processed.

balance_currency_earningsstring or null

Total earnings for this transaction in your balance currency. This is the total minus the Paddle fee. null until the transaction is completed and the fee is processed.

credit_to_balancestring

Additional credit generated from negative details.line_items. This credit is added to the customer balance.

Related pages