Invoices

List, retrieve, finalize, and void invoices
View as Markdown

Invoices are generated automatically by Prolifi’s billing engine when a subscription billing cycle completes. You can also finalize or void invoices through the API.

Endpoints

MethodPathDescription
GET/invoicesList invoices (paginated)
GET/invoices/{id}Get an invoice
POST/invoices/{id}/finalizeFinalize a pending invoice
POST/invoices/{id}/voidVoid an invoice

Key concepts

  • Invoice lifecycle: Invoices progress through statuses — pendingpostedpaid (or void).
  • Finalization: Only pending invoices can be finalized. Finalizing transitions an invoice to posted, making it ready for payment collection.
  • Voiding: Cancels an invoice. Already-voided invoices cannot be voided again.
  • Line items: Each invoice contains line items that break down the charges (plan, add-ons, usage, etc.).
  • Filtering: Use customer_id, status, or subscription_id query parameters to filter the list.