Transactions capture and calculate revenue for both checkouts and invoices. They hold information about a customer purchase. Transaction line items are the individual items that make up a transaction.
When to use
- Analyze revenue by product or price
Break transactions down to the individual items so you can see which products and prices drive revenue. - Audit subscription billing
See line-level detail for renewals, one-time charges, and proration. - Feed product-level analytics
Export itemized transaction data into BI tools for cohort, mix, and product performance analysis.
Report filters
When generating transaction line item reports, you can filter by:
| Field | Description |
|---|---|
| Updated date | The 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.
|
| Origin | Where or why the transaction was created.
|
| Currency | The currency of the transaction. |
| Collection mode | How the customer has been asked to pay.
|
Report columns
Column headings on transaction line item reports mirror fields in the Paddle API. Data is provided in the following columns:
transaction_idstring
Example:
txn_01h04vsbhqc62t8hmd4z3b578cPaddle ID of the related transaction, prefixed with
txn_.Pattern:
^txn_[a-z\d]{26}$transaction_statusstring
Status of the related transaction.
Values
draftTransaction is missing required fields. Typically the first stage of a checkout before customer details are captured.readyTransaction has all of the required fields to be marked asbilledorcompleted.billedTransaction has been updated tobilled. Billed transactions get an invoice number and are considered a legal record. They cannot be changed. Typically used as part of an invoice workflow.paidTransaction is fully paid, but has not yet been processed internally.completedTransaction is fully paid and processed.
+ Show all values− Hide values
canceledTransaction has been updated tocanceled. If an invoice, it's no longer due.past_dueTransaction 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.
invoice_numberstring | null
Invoice number for this transaction. Automatically generated by Paddle when you mark a transaction as
billed where collection_mode is manual.customer_idstring | null
Example:
ctm_01grnn4zta5a1mf02jjze7y2ysPaddle ID of the customer that this transaction is for, prefixed with
ctm_.Pattern:
^ctm_[a-z\d]{26}$customer_emailstring (email)
Example:
test@paddle.comEmail address for the customer that this transaction is for.
Length: 1–320
address_idstring | null
Example:
add_01gm302t81w94gyjpjpqypkzkfPaddle ID of the address that this transaction is for, prefixed with
add_.Pattern:
^add_[a-z\d]{26}$customer_country_codestring
Supported two-letter ISO 3166-1 alpha-2 country code of the address that this transaction is for.
Values
ADAndorraAEUnited Arab EmiratesAGAntigua and BarbudaAIAnguillaALAlbania
+ Show all values− Hide values
AMArmeniaAOAngolaARArgentinaASAmerican SamoaATAustriaAUAustraliaAWArubaAXÃ…land IslandsAZAzerbaijanBABosnia and HerzegovinaBBBarbadosBDBangladeshBEBelgiumBFBurkina FasoBGBulgariaBHBahrainBIBurundiBJBeninBLSaint BarthélemyBMBermudaBNBruneiBOBoliviaBQCaribbean Netherlands (Bonaire, Sint Eustatius, and Saba)BRBrazilBSBahamasBTBhutanBVBouvet IslandBWBotswanaBZBelizeCACanadaCCCocos IslandsCGRepublic of CongoCHSwitzerlandCICôte d'Ivoire (Ivory Coast)CKCook IslandsCLChileCMCameroonCNChinaCOColombiaCRCosta RicaCVCape VerdeCWCuraçaoCXChristmas IslandCYCyprusCZCzechia (Czech Republic)DEGermanyDJDjiboutiDKDenmarkDMDominicaDODominican RepublicDZAlgeriaECEcuadorEEEstoniaEGEgyptEHWestern SaharaEREritreaESSpainETEthiopiaFIFinlandFJFijiFKFalkland IslandsFMMicronesiaFOFaroe IslandsFRFranceGAGabonGBUnited KingdomGDGrenadaGEGeorgiaGFFrench GuianaGGGuernseyGHGhanaGIGibraltarGLGreenlandGMGambiaGNGuineaGPGuadeloupeGQEquatorial GuineaGRGreeceGSSouth Georgia and the South Sandwich IslandsGTGuatemalaGUGuamGWGuinea-BissauGYGuyanaHKHong KongHMHeard Island and McDonald IslandsHNHondurasHRCroatiaHUHungaryIDIndonesiaIEIrelandILIsraelIMIsle of ManINIndiaIOBritish Indian Ocean TerritoryIQIraqISIcelandITItalyJEJerseyJMJamaicaJOJordanJPJapanKEKenyaKGKyrgyzstanKHCambodiaKIKiribatiKMComorosKNSaint Kitts and NevisKRSouth KoreaKWKuwaitKYCayman IslandsKZKazakhstanLALao People's Democratic Republic (Laos)LBLebanonLCSaint LuciaLILiechtensteinLKSri LankaLRLiberiaLSLesothoLTLithuaniaLULuxembourgLVLatviaMAMoroccoMCMonacoMDMoldovaMEMontenegroMFSaint MartinMGMadagascarMHMarshall IslandsMKMacedoniaMNMongoliaMOMacaoMPNorthern Mariana IslandsMQMartiniqueMRMauritaniaMSMontserratMTMaltaMUMauritiusMVMaldivesMWMalawiMXMexicoMYMalaysiaMZMozambiqueNANamibiaNCNew CaledoniaNENigerNFNorfolk IslandNGNigeriaNLNetherlandsNONorwayNPNepalNRNauruNUNiueNZNew ZealandOMOmanPAPanamaPEPeruPFFrench PolynesiaPGPapua New GuineaPHPhilippinesPKPakistanPLPolandPMSaint Pierre and MiquelonPNPitcairnPRPuerto RicoPSPalestinian territoriesPTPortugalPWPalauPYParaguayQAQatarREReunionRORomaniaRSRepublic of SerbiaRWRwandaSASaudi ArabiaSBSolomon IslandsSCSeychellesSESwedenSGSingaporeSHSaint HelenaSISloveniaSJSvalbard and Jan MayenSKSlovakiaSLSierra LeoneSMSan MarinoSNSenegalSRSurinameSTSão Tomé and PrÃncipeSVEl SalvadorSXSint MaartenSZSwazilandTCTurks and Caicos IslandsTDChadTFFrench Southern and Antarctic LandsTGTogoTHThailandTJTajikistanTKTokelauTLTimor-LesteTMTurkmenistanTNTunisiaTOTongaTRTurkeyTTTrinidad and TobagoTVTuvaluTWTaiwanTZTanzaniaUAUkraineUGUgandaUMUnited States Minor Outlying IslandsUSUnited StatesUYUruguayUZUzbekistanVAHoly See (Vatican City)VCSaint Vincent and the GrenadinesVGBritish Virgin IslandsVIU.S. Virgin IslandsVNVietnamVUVanuatuWFWallis and FutunaWSSamoaXKKosovoYTMayotteZASouth AfricaZMZambia
business_idstring | null
Example:
biz_01grrebrzaee2qj2fqqhmcyzajPaddle ID of the business that this transaction is for, prefixed with
biz_.Pattern:
^biz_[a-z\d]{26}$business_namestring | null
Name of the business that this transaction is for.
Max length: 1024
subscription_idstring | null
Example:
sub_01h04vsc0qhwtsbsxh3422wjs4Paddle ID of the subscription that this transaction is for, prefixed with
sub_.Pattern:
^sub_[a-z\d]{26}$idstring
Example:
txnitm_01gm302t81w94gyjpjpqypkzkfUnique Paddle ID for this transaction item, prefixed with
txnitm_. Used when working with adjustments.Pattern:
^txnitm_[a-z\d]{26}$product_idstring
Example:
pro_01gsz97mq9pa4fkyy0wqenepkzPaddle ID of the product that this transaction item is for, prefixed with
pro_.Pattern:
^pro_[a-z\d]{26}$product_namestring
Name of the product related to this transaction item.
Length: 1–200
price_idstring
Example:
pri_01gsz8z1q1n00f12qt82y31smhPaddle ID of the price that this transaction item is for, prefixed with
pri_.Pattern:
^pri_[a-z\d]{26}$price_descriptionstring
Internal description for this price, not shown to customers. Typically notes for your team.
Length: 2–200
billing_cycle_frequencyinteger | null
Amount of time for the billing cycle of the related price, if recurring.
Min: 1
billing_cycle_intervalstring | null
Unit of time for the billing cycle of the related price, if recurring.
Values
dayweekmonthyear
trial_period_frequencyinteger | null
Amount of time for the trial period of the related price, if set.
Min: 1
trial_period_intervalstring | null
Unit of time for the trial period of the related price, if set.
Values
dayweekmonthyear
transaction_currency_codestring
Supported three-letter ISO 4217 currency code for this transaction.
Values
USDUnited States DollarEUREuroGBPPound SterlingJPYJapanese YenAUDAustralian Dollar
+ Show all values− Hide values
CADCanadian DollarCHFSwiss FrancHKDHong Kong DollarSGDSingapore DollarSEKSwedish KronaARSArgentine PesoBRLBrazilian RealCLPChilean PesoCNYChinese YuanCOPColombian PesoCZKCzech KorunaDKKDanish KroneHUFHungarian ForintILSIsraeli ShekelINRIndian RupeeKRWSouth Korean WonMXNMexican PesoNOKNorwegian KroneNZDNew Zealand DollarPENPeruvian SolPLNPolish ZlotyRUBRussian RubleTHBThai BahtTRYTurkish LiraTWDNew Taiwan DollarUAHUkrainian HryvniaVNDVietnamese DongZARSouth African Rand
unit_pricestring
Unit price for this transaction item.
quantitystring
Quantity of this transaction item on the related 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.
proration_ratestring
How proration was calculated for this item. Rate used to calculate proration.
billing_period_starts_atstring (date-time) | null
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when the billing period for this transaction starts.
billing_period_ends_atstring (date-time) | null
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when the billing period for this transaction ends.
tax_ratestring
Example:
0.2Rate used to calculate tax for this transaction line item.
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.
Values
AUDAustralian DollarCADCanadian DollarCHFSwiss FrancCNYChinese YuanCZKCzech Koruna
+ Show all values− Hide values
DKKDanish KroneEUREuroGBPPound SterlingHUFHungarian ForintPLNPolish ZlotySEKSwedish KronaUSDUnited States DollarZARSouth African Rand
transaction_to_balance_currency_exchange_ratestring
Example:
1.0513135Exchange rate used to convert between the transaction currency to your balance currency.
1.0 if currencies match.transaction_created_atstring (date-time)
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when the related transaction was marked as
created. null for transactions that are not billed or completed.updated_atstring (date-time)
Example:
2024-10-13T07:20:50.52ZRFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
billed_atstring (date-time) | null
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when the related transaction was marked as
billed. null for transactions that are not billed or completed.payment_captured_atstring (date-time) | null
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when payment was last captured for the related transaction.
balance_updated_atstring (date-time) | null
Example:
2024-10-13T07:20:50.52ZRFC 3339 datetime string of when the balance for the related transaction was last updated.
completed_atstring (date-time) | null
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when the related 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.
Values
alipayAlipay, popular in China.apple_payApple Pay on a supported Apple device.bancontactBancontact, popular in Belgium.blikBLIK, a popular payment method in Poland.cardCredit or debit card.
+ Show all values− Hide values
google_payGoogle Pay on a supported Android device, Chromebook, or Google Chrome browser.idealiDEAL, popular in the Netherlands.kakao_payKakao Pay, a popular payment method in South Korea.korea_localMulti-step Korean payment method workflow, which includes multiple payment options for the Korean market. Deprecated - usesouth_korea_local_card,kakao_pay,naver_pay,payco, orsamsung_payinstead.south_korea_local_cardKorean local credit or debit card.mb_wayMB WAY, a popular payment method in Portugal.naver_payNaver Pay, a popular payment method in South Korea.offlinePayment recorded offline.paycoPayco, a popular payment method in South Korea.paypalPayPal.pixPix, popular in Brazil. Available in early access.samsung_paySamsung Pay, a popular payment method in South Korea.unknownPayment method not known.upiUnified Payments Interface (UPI), popular in India. Available in early access.wechat_payWeChat Pay, a popular payment method in China.wire_transferWire transfer, sometimes called bank transfer.
originstring
How this transaction was created.
Values
apiTransaction created via the Paddle API.subscription_chargeTransaction created automatically by Paddle as a result of a one-time charge for a subscription.subscription_payment_method_changeTransaction created automatically as part of updating a payment method. May be a zero value transaction.subscription_recurringTransaction created automatically by Paddle as a result of a subscription renewal.subscription_updateTransaction created automatically by Paddle as a result of an update to a subscription.
+ Show all values− Hide values
webTransaction created automatically by Paddle.js for a checkout.
collection_modestring
How payment is collected for this transaction.
automatic for checkout, manual for invoices.Values
automaticPayment is collected automatically using a checkout initially, then using a payment method on file.manualPayment is collected manually. Customers are sent an invoice with payment terms and can make a payment offline or using a checkout. Requiresbilling_details.
custom_dataobject
Example:
{"customer_reference_id":"abcd1234"}Your own structured key-value data.
payment_terms_frequencyinteger | null
Amount of time for the payment terms set for this transaction. Only present for manually-collected transactions.
payment_terms_intervalstring | null
Unit of time for the payment terms set for this transaction. Only present for manually-collected transactions.
Values
dayweekmonthyear
additional_informationstring | null
Notes or other information included on the invoice document generated for this transaction. Only present for manually-collected transactions.
purchase_order_numberstring | null
Customer purchase order number. Only present for manually-collected transactions.
checkout_enabledboolean | null
Whether the related transaction may be paid using a Paddle Checkout. Only present for manually-collected transactions.