Get a PDF invoice for a transaction

Returns a link to an invoice PDF for a transaction.

Invoice PDFs are available for both automatically and manually-collected transactions:

  • The PDF for manually-collected transactions includes payment terms, purchase order number, and notes for your customer. It's a demand for payment from your customer. It's available for transactions that are billed or completed.
  • The PDF for automatically-collected transactions lets your customer know that payment was taken successfully. Customers may require this for for tax-reporting purposes. It's available for transactions that are completed.

Invoice PDFs aren't available for zero-value transactions.

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

Path Parameters

transaction_idstringrequired

Paddle ID of the transaction entity to work with.

Query Parameters

dispositionstring

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

Default: attachment.

Response

dataobject
urlstring

URL of the requested resource.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.