Adjustments

List adjustments

Changed on

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

get/adjustments

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Query parameters

idstring[]

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

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.

actionAdjustmentActionQuery[]

Return entities for the specified action. Use a comma-separated list to specify multiple action values.

customer_idstring[]

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.

statusAdjustmentStatusQuery[]

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

subscription_idstring[]

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

transaction_idstring[]

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

Headers

Skip-Countstring

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 chargeback from the query request parameter action

    • breaking

      removed the enum value chargeback_reverse from the query request parameter action

    • breaking

      removed the enum value chargeback_warning from the query request parameter action

    • breaking

      removed the enum value chargeback_warning_reverse from the query request parameter action

    • breaking

      removed the enum value credit from the query request parameter action

    • breaking

      removed the enum value credit_reverse from the query request parameter action

    • breaking

      removed the enum value refund from the query request parameter action

    • breaking

      for the query request parameter action, the type changed from string to array

    • warning

      added the new CLP enum value to the /// response property for the response status

    • warning

      added the new CLP enum value to the ///// response property for the response status

    • warning

      added the new PEN enum value to the /// response property for the response status

    • warning

      added the new PEN enum value to the ///// response property for the response status

    • info

      added the new optional header request parameter Skip-Count

    • breaking

      the // response property's maxLength was unset from 3 for the response status

    • breaking

      the // response property's minLength was decreased from 3 to 0 for the response status

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the /// response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the response's property type changed from object to 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 property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the //// response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      removed subschema #1 from the /// response property allOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the // response property anyOf list 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 ARS enum value from the // response property for the response status

    • info

      removed the AUD enum value from the // response property for the response status

    • info

      removed the BRL enum value from the // response property for the response status

    • info

      removed the CAD enum value from the // response property for the response status

    • info

      removed the CHF enum value from the // response property for the response status

    • info

      removed the CNY enum value from the // response property for the response status

    • info

      removed the COP enum value from the // response property for the response status

    • info

      removed the CZK enum value from the // response property for the response status

    • info

      removed the DKK enum value from the // response property for the response status

    • info

      removed the EUR enum value from the // response property for the response status

    • info

      removed the GBP enum value from the // response property for the response status

    • info

      removed the HKD enum value from the // response property for the response status

    • info

      removed the HUF enum value from the // response property for the response status

    • info

      removed the ILS enum value from the // response property for the response status

    • info

      removed the INR enum value from the // response property for the response status

    • info

      removed the JPY enum value from the // response property for the response status

    • info

      removed the KRW enum value from the // response property for the response status

    • info

      removed the MXN enum value from the // response property for the response status

    • info

      removed the NOK enum value from the // response property for the response status

    • info

      removed the NZD enum value from the // response property for the response status

    • info

      removed the PLN enum value from the // response property for the response status

    • info

      removed the RUB enum value from the // response property for the response status

    • info

      removed the SEK enum value from the // response property for the response status

    • info

      removed the SGD enum value from the // response property for the response status

    • info

      removed the THB enum value from the // response property for the response status

    • info

      removed the TRY enum value from the // response property for the response status

    • info

      removed the TWD enum value from the // response property for the response status

    • info

      removed the UAH enum value from the // response property for the response status

    • info

      removed the USD enum value from the // response property for the response status

    • info

      removed the VND enum value from the // response property for the response status

    • info

      removed the ZAR enum value from the // response property for the response status

    • info

      removed the approved enum value from the // response property for the response status

    • info

      removed the full enum value from the // response property for the response status

    • info

      removed the partial enum value from the // response property for the response status

    • info

      removed the pending_approval enum value from the // response property for the response status

    • info

      removed the rejected enum value from the // response property for the response status

    • info

      removed the reversed enum value from the // response property for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      removed subschema #2 from the // response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the // response property oneOf list 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