API Reference · Invoices

Update an invoice

Edits a DRAFT invoice.

PATCH/v1/invoices/:id

Only DRAFT invoices may be updated. OPEN and PAID invoices are immutable except via `send`, `void`, and payment webhooks. Returns 409 if the invoice is not in DRAFT.

Returnsinvoice object

Path parameters

idstringRequired

Invoice id (`inv_…`).

Body parameters

line_itemsarray

Replaces the entire line items array.

tax_rate_bpsinteger

New tax rate in basis points.

payment_termsstring

New payment terms.

due_datestring

New ISO due date.

notesstring

New customer-facing note.

metadataobject

Merged into existing metadata.

Errors

404

resource_missing

No invoice exists with that id.

409

invoice_not_editable

Invoice is not in DRAFT status.

Request

curl -X PATCH https://lunipay.io/api/v1/invoices/inv_01JRZK7T9A3BXCZV2QKH5E8RMP \
  -H "Authorization: Bearer sk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "notes": "Net-30 terms as agreed." }'

Response

{
  "id": "inv_01JRZK7T9A3BXCZV2QKH5E8RMP",
  "object": "invoice",
  "livemode": false,
  "customer_id": "cus_01JRZK2Q4T9ZS0VCNA3HX7W9EY",
  "invoice_number": "INV-0042",
  "status": "DRAFT",
  "currency": "usd",
  "subtotal_cents": 10000,
  "tax_rate_bps": 1500,
  "tax_amount_cents": 1500,
  "total_cents": 11500,
  "amount_paid_cents": 0,
  "amount_due_cents": 11500,
  "payment_terms": "net_30",
  "due_date": "2026-05-14",
  "notes": "Net-30 terms as agreed.",
  "line_items": [
    {
      "description": "Consulting — April 2026",
      "quantity": 10,
      "unit_price_cents": 1000,
      "total_cents": 10000
    }
  ],
  "installment_enabled": false,
  "installment_count": null,
  "hosted_invoice_url": "https://lunipay.io/pay/inv_01JRZK7T9A3BXCZV2QKH5E8RMP",
  "metadata": null,
  "sent_at": null,
  "paid_at": null,
  "created": 1713100800,
  "updated": 1713100800
}