List adjustments

gethttps://api.paddle.com/adjustments

Returns a paginated list of adjustments. Use the query parameters to page through results.

Query Parameters

actionstring

Return entities for the specified action.

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

customer_idarray[string]

Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

per_pageinteger

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.

statusarray[string]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

subscription_idarray[string]

Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs.

transaction_idarray[string]

Return entities related to the specified transaction. Use a comma-separated list to specify multiple transaction IDs.

idarray[string]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

Response

dataarray[object]

Represents an adjustment entity.

idstring

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

actionstring

How this adjustment impacts the related transaction.

transaction_idstring

Paddle ID of the transaction that this adjustment is for, prefixed with txn_.

subscription_idstring or null

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.

customer_idstring

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.

reasonstring

Why this adjustment was created. Appears in the Paddle dashboard. Retained for record-keeping purposes.

credit_applied_to_balanceboolean or null

Whether this adjustment was applied to the related customer's credit balance. Only returned for credit adjustments.

false where the related transaction is billed. The adjustment reduces the amount due on the transaction.

true where the related transaction is completed. The amount is added the customer's credit balance and used to pay future transactions.

currency_codestring

Three-letter ISO 4217 currency code for this adjustment. Set automatically by Paddle based on the currency_code of the related transaction.

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.

itemsarray[object]

List of items on this adjustment.

totalsobject

Breakdown of the total for an adjustment.

payout_totalsobject or null

Breakdown of how this adjustment affects your payout balance.

tax_rates_usedarray[object]

List of tax rates applied for this adjustment.

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.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

paginationobject

Keys used for working with paginated results.

Response