Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Invoices

Finalize a draft invoice

Move an invoice from draft to pending status, making it ready for payment.

post/api/invoices/{id}/finalize

Path parameters

idstring required

Invoice ID

Response

Invoice finalized and set to pending

idstring required
invoiceNumberstring required
subscriptionIdstring
customerIdstring required
amountstring required

Decimal amount as string

currencystring required
status'DRAFT' | 'PENDING' | 'PAID' | 'FAILED' | 'CANCELED' required
dueDatestring required
paidAtstring
pdfUrlstring
metadataobject

Line items, plan info, discounts

createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "invoiceNumber": "INV-2026-0001",
  "customerId": "clxcust123",
  "amount": "99.9900",
  "currency": "USD",
  "status": "DRAFT",
  "pdfUrl": "/uploads/invoices/inv-123.pdf",
  "customer": {
    "id": "clx1234567890",
    "name": "Jane Doe",
    "email": "jane@example.com"
  }
}