Skip to main content
GET
/
adjustments
/
{adjustment_id}
/
credit-note
Get a PDF credit note for an adjustment
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/adjustments/{adjustment_id}/credit-note', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "url": "https://paddle-production-invoice-service-pdfs.s3.amazonaws.com/credit_notes/15839/crdnt_01j4scmgpbtbxap16573dtck9n/credit_notes_296-10016_Paddle-com.pdf"
  },
  "meta": {
    "request_id": "e34d4a9c-2088-447d-a3a1-1da5ce74f507"
  }
}

Authorizations

​
Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

​
adjustment_id
string
required

Paddle ID of the adjustment entity to work with.

Example:

"adj_01ghvjt9dbpnndeqjve8cktgqs"

Query Parameters

​
disposition
enum<string>
default:attachment

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

Default: attachment.

Available options:
attachment,
inline

Response

OK

​
data
Adjustment credit note PDF · object
required
​
meta
Meta · object
required

Information about this response.