Skip to content

Get invoice PDF download link

GET/invoices/{slug}/pdf

Costs 1 rate-limit point · Rate limits

Generate (if needed) and return a signed download URL for the invoice or packing slip PDF. Optionally specify a template.

Path parameters

  • slugstringRequired

    The invoice's unique slug (UUID).

Query parameters

  • template_idinteger

    Optional template ID. Falls back to the store's default.

  • packing_slipboolean

    Set true to return the packing slip instead of the invoice. Inferred automatically when template_id points at a packing slip template. Packing slips are stored separately, so both documents stay retrievable for the same order.

Returns

  • invoiceobject
    Show 3 child attributesHide child attributes
    • slugstring
      Example: k7xq2m9d4r
    • numberstring
      Example: INV-1042
    • pdf_urlstring

      Signed download URL.

Errors

401

Missing or invalid API key.

403

The store is not on a paid plan. API access requires a paid Invoice Falcon plan.

404

Resource not found.

422

Request could not be processed.

429

Rate limit exceeded. Check X-RateLimit-Reset header.

GET/invoices/{slug}/pdf
curl "https://app.invoicefalcon.com/api/v1/external/invoices/{slug}/pdf" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "invoice": {
    "slug": "k7xq2m9d4r",
    "number": "INV-1042",
    "pdf_url": "https://invoicefalcon.com/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsiZXhhbXBsZSI6dHJ1ZX19/INV-1042.pdf?disposition=attachment"
  }
}