What's new?
We've added credit notes, sometimes called credit memos in other solutions, to the Paddle platform. They're automatically sent to customers when you refund or credit a transaction.
As part of this change, we added the get a PDF credit note for an adjustment operation to the API.
/adjustments/{adjustment_id}/credit-note Paddle ID of the adjustment that you want to generate a credit note for.
How it works
Use adjustments to refund or credit all or part of a transaction after it's been billed or completed.
With this update, we automatically send a credit note to customers as a PDF so they have a record of a refund or credit. You can also download credit notes from the Paddle dashboard or generate them using the API.
The get a PDF credit note for an adjustment operation mirrors the get a PDF invoice for a transaction operation, returning a link to a PDF.
Credit notes are available for adjustment entities from August 30, 2024. You can't generate credit notes for adjustments created before then.
Next steps
Platform changes are available now. You don't need to do anything to get these changes. Paddle automatically sends credit notes to customers when you refund or credit a transaction.
API changes are available in version 1 of the Paddle API. It's a non-breaking change, meaning it doesn't impact existing integrations.
You can get a PDF credit note for an adjustment using the API to generate a URL to a credit note. Credit notes are available for adjustments created after September 2nd, 2024.
Summary of changes
| Entity | Field | Change | Type |
|---|---|---|---|
| Adjustments | GET Get a PDF credit note for an adjustment | + Added | API operation |