Create an adjustment
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:
- Refunds return an amount to a customer's original payment method. You can create refund adjustments for transactions that are
completed. - Credits reduce the amount that a customer has to pay for a transaction. You can create credit adjustments for manually-collected transactions that are
billedorpast_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.
Request Body
How this adjustment impacts the related transaction.
Why this adjustment was created. Appears in the Paddle dashboard. Retained for record-keeping purposes.
Paddle 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.
Type of adjustment. Use full to adjust the grand total for the related transaction. Include an items array when creating a partial adjustment. If omitted, defaults to partial.
List of transaction items to adjust. Required if type is not populated or set to partial.
Paddle ID for the transaction item that this adjustment item relates to, prefixed with txnitm_.
Type of adjustment for this transaction item. tax adjustments are automatically created by Paddle. Include amount when creating a partial adjustment.
Amount adjusted for this transaction item. Required when item type is partial.
Response
Represents an adjustment entity.
Unique Paddle ID for this adjustment entity, prefixed with adj_.
How this adjustment impacts the related transaction.
Type of adjustment. Use full to adjust the grand total for the related transaction. Include an items array when creating a partial adjustment. If omitted, defaults to partial.
Paddle ID of the transaction that this adjustment is for, prefixed with txn_.
Paddle ID for the subscription related to this adjustment, prefixed with sub_. Set automatically by Paddle based on the subscription_id of the related transaction.
Paddle ID for the customer related to this adjustment, prefixed with ctm_. Set automatically by Paddle based on the customer_id of the related transaction.
Why this adjustment was created. Appears in the Paddle dashboard. Retained for record-keeping purposes.
Whether this adjustment was applied to the related customer's credit balance. Only returned for credit adjustments.
Three-letter ISO 4217 currency code for this adjustment. Set automatically by Paddle based on the currency_code of the related transaction.
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.
List of items on this adjustment. Required if type is not populated or set to partial.
Breakdown of the total for an adjustment.
Breakdown of how this adjustment affects your payout balance.
List of tax rates applied for this adjustment.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
1234567891011121{
2 "action": "refund",
3 "items": [
4 {
5 "item_id": "txnitm_01hvcc94b7qgz60qmrqmbm19zw",
6 "type": "partial",
7 "amount": "100"
8 }
9 ],
10 "reason": "error",
11 "transaction_id": "txn_01hvcc93znj3mpqt1tenkjb04y"
12}