Create an adjustment
POST {{baseUrl}}/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:
- 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
billed
orpast_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
{"action"=>"<string>", "transaction_id"=>"<string>", "reason"=>"<string>", "items"=>[{"item_id"=>"<string>", "type"=>"<string>", "amount"=>"<string,null>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |