v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Invoices

Generate invoice from charges

Generate an invoice from charges within a billing period. Automatically aggregates charges by usage type into line items.

The invoice is created in DRAFT status. Use the issue endpoint to finalize it.

post/v1/invoices/generate

Request body

customerIdstring required

Customer ID to generate invoice for

periodStartstring date-time required

Start of billing period (ISO 8601)

periodEndstring date-time required

End of billing period (ISO 8601)

dueDatestring date-time

Payment due date (ISO 8601)

includeSettledOnlyboolean

Only include settled (confirmed) charges

notesstring

Internal notes (not visible to customer)

customerNotesstring

Notes visible to customer on invoice

Response

Invoice generated successfully

idstring
invoiceNumberstring
customerIdstring
periodStartstring
periodEndstring
totalUsdcstring
statusstring
createdAtstring