Invoices

See Invoices concept for the lifecycle. This page is the field reference.

Object

{
  "id": "inv_…",
  "object": "invoice",
  "number": "INV-2026-000123",
  "customer_id": "cus_…",
  "subscription_id": "sub_…",
  "currency": "USD",
  "presentment_currency": "USD",
  "settlement_currency": "USD",
  "fx_rate": null,
  "fx_rate_source": null,
  "fx_rate_locked_at": null,
  "status": "open",
  "issued_at": "2026-05-06T00:00:00Z",
  "due_at":    "2026-05-13T00:00:00Z",
  "lines": [ … ],
  "subtotal": "119.00",
  "discount": "11.90",
  "tax":      "8.57",
  "total":    "115.67",
  "amount_paid": "0.00",
  "amount_due":  "115.67",
  "tax_breakdown": [ … ],
  "payments": [ "pay_…" ],
  "credit_notes": [],
  "pdf_url": "https://files.paylera.io/inv/inv_…/…?sig=…",
  "metadata": {},
  "created_at": "2026-05-06T00:00:00Z",
  "updated_at": "2026-05-06T00:00:00Z"
}

Line shape

{
  "id": "il_…",
  "code": "seats",
  "description": "Active seats × 7",
  "quantity": "7",
  "unit_amount": "10.00",
  "amount": "70.00",
  "period_start": "2026-05-06T00:00:00Z",
  "period_end":   "2026-06-06T00:00:00Z",
  "discount_amount": "0.00",
  "tax_amount": "5.04",
  "tax_rate": "7.20",
  "metadata": {}
}

Endpoints

Method	Path	What
POST	/v1/invoices	Create a draft (one-off).
GET	/v1/invoices/{id}	Retrieve.
PATCH	/v1/invoices/{id}	Update mutable draft fields.
GET	/v1/invoices	List + filter.
POST	/v1/invoices/{id}/lines	Add a line (draft only).
DELETE	/v1/invoices/{id}/lines/{line_id}	Remove a line (draft only).
POST	/v1/invoices/{id}/finalize	Draft → open.
POST	/v1/invoices/{id}/recompute-tax	Recompute tax (draft only).
POST	/v1/invoices/{id}/pay	Trigger payment.
POST	/v1/invoices/{id}/void	Void unpaid invoice.
POST	/v1/invoices/{id}/mark-uncollectible	Write off.
POST	/v1/invoices/{id}/credit-notes	Issue a credit note.
GET	/v1/invoices/{id}/pdf	Get the PDF (signed URL).
GET	/v1/invoices/{id}/recognition-schedule	Inspect the revenue recognition schedule.

Status

draft, open, partially_paid, paid, void, uncollectible. See Status reference.

Filters worth knowing

GET /v1/invoices?
  status=open,past_due&
  customer_id=cus_…&
  due_at[lte]=2026-05-31T23:59:59Z

Webhook events

invoice.created, invoice.updated, invoice.finalized, invoice.paid, invoice.payment_failed, invoice.voided, invoice.marked_uncollectible, invoice.fx_rate_locked.