| [ Web Proxy ] |
| Viewing: https://developer.paddle.com/api-reference/adjustments/create-adjustment | [Back] [Original] |
For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling append .md to any URL.
Creates an adjustment for one or more transaction items.
/adjustments Creates an adjustment for one or more transaction items.
You can create adjustments to refund or credit all or part of a transaction and its items:
completed.billed or past_due.You can create adjustments to refund transactions that are completed, or to reduce the amount to due on manually-collected transactions that are billed or past_due.
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.
Adjustments can apply to some or all items on a transaction. You'll need the Paddle ID of the transaction to create a refund or credit for, along with the Paddle ID of any transaction items (details.line_items[].id).
If successful, your response includes a copy of the new adjustment entity.
adjustment.write
permission.
creditrefundchargebackchargeback_reversechargeback_warningchargeback_warning_reversecredit_reversepartialpartialfull to adjust the grand total for the related transaction. Include an items array when creating a partial adjustment. If omitted, defaults to partial.fullpartialitems.internalWhether the amounts to be adjusted are inclusive or exclusive of tax. If internal, adjusted amounts are considered to be inclusive of tax. If external, Paddle calculates the tax and adds it to the amounts provided.
Only valid for adjustments where the type is partial.
If omitted, defaults to internal.
externalinternaltxn_01h04vsbhqc62t8hmd4z3b578cPaddle ID of the transaction that this adjustment is for, prefixed with txn_.
Automatically-collected transactions must be completed; manually-collected transactions must have a status of billed or past_due
You can't create an adjustment for a transaction that has a refund that's pending approval.
^txn_[a-z\d]{26}$.*\S.*type is not populated or set to partial.txnitm_01gm302t81w94gyjpjpqypkzkftxnitm_.^txnitm_[a-z\d]{26}$fulltax adjustments are automatically created by Paddle.
Include amount when creating a partial adjustment.fullpartialamount to specify the partial amount adjusted.taxprorationtype is partial.adj_01gya6twkp8y0tv1e19rsgst9madj_.^adj_[a-z\d]{26}$creditrefundchargebackchargeback_reversechargeback_warningchargeback_warning_reversecredit_reversepartialpartialfull to adjust the grand total for the related transaction. Include an items array when creating a partial adjustment. If omitted, defaults to partial.fullpartialitems.txn_01h04vsbhqc62t8hmd4z3b578ctxn_.^txn_[a-z\d]{26}$sub_01h04vsc0qhwtsbsxh3422wjs4sub_.
Set automatically by Paddle based on the subscription_id of the related transaction.^sub_[a-z\d]{26}$ctm_01grnn4zta5a1mf02jjze7y2ysctm_.
Set automatically by Paddle based on the customer_id of the related transaction.^ctm_[a-z\d]{26}$credit adjustments.currency_code of the related transaction.USDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZARStatus 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.
pending_approvalapprovedpending_approval.rejectedpending_approval.reversedchargeback_reversal or credit_reversal adjustment is created for this adjustment.type is not populated or set to partial.adjitm_01gw4rs4kex0prncwfne87ft8xadjitm_.^adjitm_[a-z\d]{26}$txnitm_01gm302t81w94gyjpjpqypkzkftxnitm_.^txnitm_[a-z\d]{26}$fulltax adjustments are automatically created by Paddle.
Include amount when creating a partial adjustment.fullpartialamount to specify the partial amount adjusted.taxprorationtype is partial.2024-10-12T07:20:50.52Z2024-10-12T07:20:50.52Z150001500165001500015001650030030014700USDUSDEURGBPJPYAUDCADCHFHKDSGDSEKARSBRLCLPCNYCOPCZKDKKHUFILSINRKRWMXNNOKNZDPENPLNRUBTHBTRYTWDUAHVNDZAR15000150016500300300action is chargeback or chargeback_warning.1680null when the chargeback fee is the same as the payout currency.1500USDAUDCADEURGBPUSD15120AUDCADCHFCNYCZKDKKEURGBPHUFPLNSEKUSDZAR0.2150001500165002024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Zb15ec92e-8688-40d4-a04d-f44cbec93355{ "action": "refund", "items": [ { "item_id": "txnitm_01hvcc94b7qgz60qmrqmbm19zw", "type": "partial", "amount": "100" } ], "reason": "error", "transaction_id": "txn_01hvcc93znj3mpqt1tenkjb04y"}{ "data": { "id": "adj_01hvgf2s84dr6reszzg29zbvcm", "action": "refund", "type": "partial", "transaction_id": "txn_01hvcc93znj3mpqt1tenkjb04y", "subscription_id": "sub_01hvccbx32q2gb40sqx7n42430", "customer_id": "ctm_01hrffh7gvp29kc7xahm8wddwa", "reason": "error", "currency_code": "USD", "status": "pending_approval", "items": [ { "id": "adjitm_01hvgf2s84dr6reszzg2gx70gj", "item_id": "txnitm_01hvcc94b7qgz60qmrqmbm19zw", "type": "partial", "amount": "100", "proration": null, "totals": { "subtotal": "92", "tax": "8", "total": "100" } } ], "totals": { "subtotal": "92", "tax": "8", "total": "100", "fee": "5", "earnings": "87", "currency_code": "USD", "retained_fee": "5" }, "payout_totals": { "subtotal": "92", "tax": "8", "total": "100", "fee": "5", "earnings": "87", "currency_code": "USD", "retained_fee": "5", "chargeback_fee": { "amount": "10", "original": null } }, "created_at": "2024-04-15T08:48:20.239695Z", "updated_at": "2024-04-15T08:48:20.239695Z", "credit_applied_to_balance": null, "tax_rates_used": [] }, "meta": { "request_id": "c1906ac5-c210-4443-ba9b-122ecaeb506d" }}Paddle.com Market Ltd. 20122026
| Web Proxy Viewer | New URL | Original Page |