Adjustments are records of changes to a transaction, like refunds or credits. They're created automatically by Paddle when making prorated changes to a subscription, or when making changes to an issued invoice. Adjustment line items are the individual items that make up an adjustment.
When to use
- Analyze refunds and credits by product
Break adjustments down to the individual items so you can see which products are most affected by refunds and credits. - Audit prorated changes
See line-level detail for adjustments created from subscription updates and downgrades. - Feed product-level refund analytics
Export itemized adjustment data into BI tools for revenue analysis.
Report filters
When generating adjustment line item reports, you can filter by:
| Field | Description |
|---|---|
| Updated date | The date an adjustment was last modified. Matches entities modified on or after the start date and before the end date. |
| Status | The current status of the adjustment.
|
| Type | Kind of adjustment.
|
Report columns
Column headings on adjustment line item reports mirror fields in the Paddle API. Data is provided in the following columns:
idstring
Example:
adjitm_01gw4rs4kex0prncwfne87ft8xUnique Paddle ID for this adjustment item, prefixed with
adjitm_.Pattern:
^adjitm_[a-z\d]{26}$adjustment_idstring
Example:
adj_01gya6twkp8y0tv1e19rsgst9mPaddle ID for the adjustment for this adjustment item, prefixed with
adj_.Pattern:
^adj_[a-z\d]{26}$transaction_idstring
Example:
txn_01h04vsbhqc62t8hmd4z3b578cPaddle ID for the transaction related to this adjustment item, prefixed with
txn_. Pattern:
^txn_[a-z\d]{26}$customer_idstring
Example:
ctm_01grnn4zta5a1mf02jjze7y2ysPaddle ID for the customer related to this adjustment, prefixed with
ctm_.Pattern:
^ctm_[a-z\d]{26}$customer_emailstring (email)
Example:
test@paddle.comEmail address for the customer that this adjustment is for.
Length: 1–320
address_idstring
Example:
add_01gm302t81w94gyjpjpqypkzkfPaddle ID for the address related to this adjustment, 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 adjustment 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 for the business related to this adjustment, prefixed with
biz_.Pattern:
^biz_[a-z\d]{26}$business_namestring | null
Name of the business that this adjustment is for.
Max length: 1024
actionstring
How this adjustment impacts the related transaction.
Values
creditCredits some or all the related transaction.refundRefunds some or all the related transaction. Must be approved by Paddle in most cases.chargebackChargeback for the related transaction. Automatically created by Paddle when a customer successfully disputes a charge.chargeback_reverseReversal of a chargeback for the related transaction. Automatically created by Paddle when Paddle contests a chargeback successfully.chargeback_warningWarning of an upcoming chargeback for the related transaction. Automatically created by Paddle.
+ Show all values− Hide values
chargeback_warning_reverseReversal of a chargeback warning for the related transaction. Automatically created by Paddle.credit_reverseReversal of a credit for the related transaction. Automatically created by Paddle.
reasonstring
Why this adjustment was created. Retained for record-keeping purposes.
statusstring
Status of this adjustment. Set automatically by Paddle.
Most refunds for live accounts are created with the status of pending_approval until reviewed by Paddle, but some are automatically approved. For sandbox accounts, Paddle automatically approves refunds every ten minutes.
Credit adjustments don't require approval from Paddle, so they're created as approved.
Values
pending_approvalAdjustment is pending approval by Paddle. Most refunds for live accounts must be approved by Paddle.approvedAdjustment is approved. Default for credits. Set when Paddle approves a refund that waspending_approval.rejectedAdjustment has been rejected. Set when Paddle rejects a refund that waspending_approval.reversedAdjustment has been reversed. Set by Paddle when achargeback_reversalorcredit_reversaladjustment is created for this adjustment.
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
created_atstring (date-time)
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)
Example:
2024-10-13T07:20:50.52ZRFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
approved_atstring (date-time) | null
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when this adjustment was marked as
approved. null for transactions that are not approved.currency_codestring
Supported three-letter ISO 4217 currency code for this adjustment.
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
subtotalstring
Total before tax in the adjustment currency.
taxstring
Total tax on the subtotal in the adjustment currency.
totalstring
Total after tax in the adjustment 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.
adjustment_to_balance_currency_exchange_ratestring
Example:
1.0513135Exchange rate used to convert between the adjustment currency to your balance currency.
1.0 if currencies match.balance_currency_subtotalstring | null
Total before tax and fees in your balance currency.
balance_currency_taxstring | null
Total tax on the subtotal in your balance currency.
balance_currency_totalstring | null
Total after discount and tax in your balance currency.