List adjustments
Changed onReturns a paginated list of adjustments. Use the query parameters to page through results.
Request
- Base URLhttps://sandbox-api.paddle.com
- AuthHTTP bearer
Query parameters
Return only the IDs specified. Use a comma-separated list to get multiple entities.
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 for the specified action. Use a comma-separated list to specify multiple action values.
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.
Headers
Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.
Response
The request has succeeded.
Example response
{
"data": [
{
"id": "adj_01gya6twkp8y0tv1e19rsgst9m",
"type": "partial",
"transaction_id": "txn_01h04vsbhqc62t8hmd4z3b578c",
"subscription_id": "sub_01h04vsc0qhwtsbsxh3422wjs4",
"customer_id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
"items": [
{
"id": "adjitm_01gw4rs4kex0prncwfne87ft8x",
"item_id": "txnitm_01gm302t81w94gyjpjpqypkzkf",
"type": "full",
"proration": {
"billing_period": {
"starts_at": "2024-10-12T07:20:50.52Z",
"ends_at": "2024-10-12T07:20:50.52Z"
}
},
"totals": {
"subtotal": "15000",
"tax": "1500",
"total": "16500"
}
}
],
"totals": {
"subtotal": "15000",
"tax": "1500",
"total": "16500",
"fee": "300",
"retained_fee": "300",
"earnings": "14700"
},
"payout_totals": {
"subtotal": "15000",
"tax": "1500",
"total": "16500",
"fee": "300",
"retained_fee": "300",
"chargeback_fee": {
"amount": "1680",
"original": {
"amount": "1500"
}
},
"earnings": "15120"
},
"tax_rates_used": [
{
"tax_rate": "0.2",
"totals": {
"subtotal": "15000",
"tax": "1500",
"total": "16500"
}
}
],
"created_at": "2024-10-12T07:20:50.52Z",
"updated_at": "2024-10-13T07:20:50.52Z"
}
],
"meta": {
"request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
"pagination": {
"estimated_total": 999
}
}
}Changes
- breaking
removed the enum value
chargebackfrom thequeryrequest parameteraction - breaking
removed the enum value
chargeback_reversefrom thequeryrequest parameteraction - breaking
removed the enum value
chargeback_warningfrom thequeryrequest parameteraction - breaking
removed the enum value
chargeback_warning_reversefrom thequeryrequest parameteraction - breaking
removed the enum value
creditfrom thequeryrequest parameteraction - breaking
removed the enum value
credit_reversefrom thequeryrequest parameteraction - breaking
removed the enum value
refundfrom thequeryrequest parameteraction - breaking
for the
queryrequest parameteraction, the type changed fromstringtoarray - warning
added the new
CLPenum value to the///response property for the response status - warning
added the new
CLPenum value to the/////response property for the response status - warning
added the new
PENenum value to the///response property for the response status - warning
added the new
PENenum value to the/////response property for the response status - info
added the new optional
headerrequest parameterSkip-Count
- breaking
- breaking
the
//response property's maxLength was unset from3for the response status - breaking
the
//response property's minLength was decreased from3to0for the response status - breaking
the
//response's property type changed fromstringto no type, and format fromdate-timeto no format for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
///response's property type changed from no type toobjectfor status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
////response's property type changed fromobjectto no type for status - breaking
the
//response's property type changed fromobjectto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type for status - breaking
the
//response's property type changed fromstringto no type, and format fromdate-timeto no format for status - breaking
the
response's property type changed fromobjectto no type for status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - breaking
removed the required property
/from the response with the status - warning
removed the optional property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
removed the optional property
/////from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
/from the response with the status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
////response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
removed
subschema #1from the///response propertyallOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #2to the//response propertyanyOflist for the response status - info
added
subschema #1subschema #2to the//response propertyanyOflist for the response status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
////became required for the status - info
the response property
////became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
//became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
removed the
ARSenum value from the//response property for the response status - info
removed the
AUDenum value from the//response property for the response status - info
removed the
BRLenum value from the//response property for the response status - info
removed the
CADenum value from the//response property for the response status - info
removed the
CHFenum value from the//response property for the response status - info
removed the
CNYenum value from the//response property for the response status - info
removed the
COPenum value from the//response property for the response status - info
removed the
CZKenum value from the//response property for the response status - info
removed the
DKKenum value from the//response property for the response status - info
removed the
EURenum value from the//response property for the response status - info
removed the
GBPenum value from the//response property for the response status - info
removed the
HKDenum value from the//response property for the response status - info
removed the
HUFenum value from the//response property for the response status - info
removed the
ILSenum value from the//response property for the response status - info
removed the
INRenum value from the//response property for the response status - info
removed the
JPYenum value from the//response property for the response status - info
removed the
KRWenum value from the//response property for the response status - info
removed the
MXNenum value from the//response property for the response status - info
removed the
NOKenum value from the//response property for the response status - info
removed the
NZDenum value from the//response property for the response status - info
removed the
PLNenum value from the//response property for the response status - info
removed the
RUBenum value from the//response property for the response status - info
removed the
SEKenum value from the//response property for the response status - info
removed the
SGDenum value from the//response property for the response status - info
removed the
THBenum value from the//response property for the response status - info
removed the
TRYenum value from the//response property for the response status - info
removed the
TWDenum value from the//response property for the response status - info
removed the
UAHenum value from the//response property for the response status - info
removed the
USDenum value from the//response property for the response status - info
removed the
VNDenum value from the//response property for the response status - info
removed the
ZARenum value from the//response property for the response status - info
removed the
approvedenum value from the//response property for the response status - info
removed the
fullenum value from the//response property for the response status - info
removed the
partialenum value from the//response property for the response status - info
removed the
pending_approvalenum value from the//response property for the response status - info
removed the
rejectedenum value from the//response property for the response status - info
removed the
reversedenum value from the//response property for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status - info
removed
subschema #2from the//response propertyoneOflist for the response status - info
removed
subschema #1subschema #2from the//response propertyoneOflist for the response status - info
the
//response's property pattern^ctm_[a-z\d]{26}$was removed for the status - info
the
//response's property pattern^adj_[a-z\d]{26}$was removed for the status - info
the
//response's property pattern^txn_[a-z\d]{26}$was removed for the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status - info
added the required property
////to the response with the status
- breaking