Invoices

Get invoice PDF

Changed on

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

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/invoices/{id}/pdf
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Invoice ID

Query parameters

urlboolean

Return presigned URL from s3 instead of PDF

force_generateboolean

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

OK

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

  • 8ec2edea6b20Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new too_many_requests enum value to the response property for the response status

    • warning

      added the new too_many_requests enum value to the response property for the response status

    • warning

      added the new too_many_requests enum value to the response property for the response status