Invoice PDF Generation

Calmony Pay can render any invoice to a PDF document and return a download URL. This is useful for sharing invoices with customers, attaching them to emails, or storing them for accounting purposes.

Endpoint

GET /v1/invoices/:id/pdf

Path Parameters

Parameter	Type	Description
id	string	The unique identifier of the invoice.

Response

Returns a JSON object containing a durable download URL pointing to the stored PDF file.

{
  "url": "https://..."
}

PDF Contents

Every generated PDF includes the following information:

Section	Details
Branding	Calmony Pay logo and branded layout
Invoice number	Unique reference number for the invoice
Payment status	Current status — e.g. paid, unpaid, overdue
Customer details	Name, address, and contact information
Dates	Invoice date and due date
Line items	Description, quantity, unit price, and line subtotal for each item
Totals	Subtotal, tax amount, and grand total

Behaviour

• The PDF is generated on request and stored before the URL is returned. Subsequent calls for the same invoice may return the same stored URL.
• The download URL is durable — it can be embedded in emails or saved for later retrieval.
• The endpoint requires a valid invoice id. If the invoice does not exist, a 404 error is returned.

Example Request

curl -X GET https://api.calmonypay.com/v1/invoices/inv_abc123/pdf \
  -H "Authorization: Bearer YOUR_SECRET_KEY"

Example Response

{
  "url": "https://files.calmonypay.com/invoices/inv_abc123.pdf"
}

Related

• Invoices API Reference
• Changelog