Overview

View as Markdown

Invoices — Base: /v1/payment-requests/billing-invoices

An invoice is a bill issued to a customer (customerId): it includes items (items), quantity, taxes (salesTax), issue and due dates (invoiceDate / dueDate), PO number and memo. When the customer decides to pay it, it generates a checkout invoice (the actual Lightning charge).

It is the INVOICE type of the payment request aggregate and is usually extended to a customer from the Customers folder.

Endpoints:

  • Create the invoice.
  • Update the invoice.
  • Send the invoice by email to one or more recipients.
  • Download the invoice as a PDF.

Everything else (list, pay, activate, complete, delete) uses the common /payment-requests routes (General operations subfolder).

⚠️ Don’t confuse it with the Checkout Invoice folder (/v1/invoice): those are the Lightning charges, not the issued bill.

Scopes: Merchant.payment_link.{read,create,update}.