Get invoice PDF

Use when delivering an invoice PDF to the customer (e.g. email attachment or download). Use url=true for a presigned URL instead of binary. Use force_generate=true to regenerate and re-upload the PDF even if one already exists in S3.

GET /invoices/{id}/pdf

Get invoice PDF

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/invoices/{id}/pdf \
  --header 'x-api-key: <api-key>'

200

"<string>"

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Invoice ID

Query Parameters

url · boolean

Return presigned URL from s3 instead of PDF

force_generate · boolean

Force regeneration of the PDF even if one already exists in S3 (default: false). Note: force_generate has no effect if invoice_pdf_url is already set on the invoice.

Response

200

*/*

OK

The response is of type file.