commercepaymentsInvoice

commercepaymentsInvoice is a data model used within the Commerce Payments platform to represent an invoice issued to a customer as part of a transaction. It encapsulates billing details, amounts, and payment status, and serves as the central reference for payments, refunds, and reconciliation. The object typically includes identifiers such as id and invoiceNumber, references to the related customer and order, financial fields like amountDue, currency, tax, shipping, and totalAmount, and operational fields such as status (draft, open, paid, past_due, canceled), dueDate, issueDate, paymentTerms, and whether it is programmable via API.

In a typical workflow, an invoice is created when an order requires payment after capture or when a customer is billed for a subscription or an on-demand service. The invoice can be paid directly, or via a linked payment method; payments update the status and generate payment events. Invoices can support partial payments, discounts, taxes, and line items that itemize products or services. They may also carry metadata for miscellaneous tracking and regulatory reporting.

The commercepaymentsInvoice object is commonly exposed through REST or SDK APIs alongside related entities such as customer, paymentMethod, and lineItem. Webhooks or events may notify external systems when the invoice is issued, paid, overdue, or voided. Practical considerations include time zone handling, currency support, and compliance with accounting standards for invoicing and record keeping.