Adjustment reports

Generate detailed reports about refunds, credits, and chargebacks.

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.

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

Report filters

When generating adjustment reports, you can filter by:

FieldDescription
Updated dateThe 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.

  • Pending approval: Adjustment is pending approval by Paddle. Refunds must be approved by Paddle and are created pending_approval.
  • Approved: Adjustment is approved. Default for credits. Set when Paddle approves a refund that was pending_approval.
  • Rejected: Adjustment has been rejected. Set when Paddle rejects a refund that was pending_approval.
  • Reversed: Adjustment has been reversed.
Type

Kind of adjustment.

  • Credit: Credits some or all the related transaction.
  • Credit reverse: Reversal of a credit for some or all the related transaction.
  • Refund: Refunds some or all the related transaction. Must be approved by Paddle.
  • Chargeback: Chargeback for the related transaction.
  • Chargeback reverse: Reversal of a chargeback for the related transaction.
  • Chargeback warning: Warning of an upcoming chargeback for the related transaction.

Report columns

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

idstring

Unique Paddle ID for this adjustment entity, prefixed with adj_.

transaction_idstring

Paddle ID for the transaction related to this adjustment, prefixed with txn_.

customer_idstring

Paddle ID for the customer related to this adjustment, prefixed with ctm_.

customer_emailstring<email>

Email address for the customer that this adjustment is for.

address_idstring

Paddle ID for the address related to this adjustment, prefixed with add_.

customer_country_codestring

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

business_idstring or null

Paddle ID for the business related to this adjustment, prefixed with biz_.

business_namestring or null

Name of the business that this adjustment is for.

actionstring

How this adjustment impacts the related transaction.

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.

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.

approved_atstring<date-time> or null

RFC 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.

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.

paddle_feestring

Total fee taken by Paddle for this adjustment in the adjustment currency.

earningsstring

Total earnings in the adjustment currency. This is the subtotal minus the Paddle fee.

chargeback_feestring or null

Chargeback fee incurred for this transaction. Only present where the adjustment action is chargeback or chargeback_warning.

retained_feestring or null

Paddle fees retained for this adjustment.

balance_currency_codestring

Three-letter ISO 4217 currency code of your balance currency.

adjustment_to_balance_currency_exchange_ratestring

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

balance_currency_subtotalstring or null

Total before tax and fees 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 adjustment in your balance currency.

balance_currency_earningsstring or null

Total earnings for this adjustment in your balance currency. This is the total minus the Paddle fee.

balance_currency_chargeback_feestring or null

Chargeback fee incurred for this transaction in your balance currency. Only present where the adjustment action is chargeback or chargeback_warning.

balance_currency_retained_feestring or null

Paddle fees retained for this adjustment in your balance currency.

Related pages