Billing

Get Invoice PDF Link

Return the download link for one invoice's PDF.

The link points at Stripe and carries its own access token, so you download the file directly from Stripe rather than through this API. Draft invoices are not served by this API and return 404.

Requires the billing_report permission. An invoice belonging to another organization returns 404.

get/payments/invoices/{invoice_id}/pdf

Request

  • Base URL: https://ai.hatz.ai/v1
  • URL: https://ai.hatz.ai/v1/payments/invoices/{invoice_id}/pdf
  • Auth: API key in header X-API-Key

Path parameters

invoice_idstring required

Stripe invoice ID, as returned by GET /payments/invoices.

Query parameters

entity_idstring nullable

Which of your organizations the invoice belongs to. Required only if you hold billing access to more than one.

Response

Successful Response

idstring required
invoice_pdfstring required

Direct link to the invoice PDF

hosted_invoice_urlstring nullable

Stripe-hosted invoice page for the same invoice

Changes

No recorded changes to this operation across all 1 revision of this API.