PApaddlehq
Adjustments

Get a PDF credit note for an adjustment

Changed on

Returns a link to a credit note PDF for an adjustment.

Credit note PDFs are created for refunds and credits as a record of an adjustment.

The link returned is not a permanent link. It expires after an hour.

get/adjustments/{adjustment_id}/credit-note

Request

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

Path parameters

adjustment_idstring required

Paddle ID of the adjustment entity to work with.

Query parameters

disposition'attachment' | 'inline'

Determine whether the generated URL should download the PDF as an attachment saved locally, or open it inline in the browser.

Default: attachment.

Response

The request has succeeded.

Example response

{
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes

  • v19ba8be0f2006Revision changes
    • breaking

      added the new path request parameter adjustment_id

    • 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

    • info

      added to the response property allOf 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

  • v150bbef23e6a1Revision changes
    • breaking

      for the query request parameter disposition, default value attachment was added