Sign in

v2

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

Create a new invoice

Create a draft invoice with line items. The total amount is automatically calculated from the items.

post/api/invoices

Request body

customerIdstring required

Customer ID

subscriptionIdstring

Subscription ID (optional)

dueDatestring required

Due date

status'DRAFT' | 'PENDING' | 'PAID' | 'FAILED' | 'CANCELED'

Override invoice status for imports

invoiceNumberstring

Override invoice number (e.g. INV-00042). Auto-generated if omitted.

currencystring

Currency override (defaults to customer currency)

paidAtstring

Paid at date (ISO 8601). For importing paid invoices.

createdAtstring

Backdate createdAt (ISO 8601). For data imports.

Example request

{
  "items": [
    {
      "description": "Premium Monthly Plan",
      "quantity": 1,
      "unitAmount": 9999.99
    }
  ],
  "dueDate": "2025-02-15"
}

Response

Invoice created in draft status

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"
  }
}