List adjustments
Returns a paginated list of adjustments. Use the query parameters to page through results.
Query Parameters
Return entities for the specified action.
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next
URL in responses for list operations.
Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs.
Order returned entities by the specified field and direction ([ASC]
or [DESC]
). For example, ?order_by=id[ASC]
.
Valid fields for ordering: id
.
Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page
in the response to see how many were returned.
Default: 10
; Maximum: 50
.
Return entities that match the specified status. Use a comma-separated list to specify multiple status values.
Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs.
Return entities related to the specified transaction. Use a comma-separated list to specify multiple transaction IDs.
Return only the IDs specified. Use a comma-separated list to get multiple entities.
Response
Represents an adjustment entity.
Unique Paddle ID for this adjustment entity, prefixed with adj_
.
How this adjustment impacts the related transaction. refund
adjustments must be approved by Paddle, and are created with the status pending_approval
.
Paddle ID for the transaction related to this adjustment, 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.
false
when the related transaction collection_mode
is manual
and its status
is billed
. The adjustment is used to reduce the balance
due on the transaction.
true
for automatically-collected transactions and completed
manually-collected transactions.
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.
refund
adjustments must be approved by Paddle, and are created with the status pending_approval
until they move to approved
or rejected
on review. Other kinds of adjustment do not need approval, so are created with the status approved
.
List of items on this adjustment.
Breakdown of the total for an adjustment.
Breakdown of how this adjustment affects your payout balance.
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.
Keys used for working with paginated results.