Skip to main content

Documentation Index

Fetch the complete documentation index at: https://test-docs.upayments.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Invoices API

​
List Invoices

GET /api/invoices?page=1&status=SENT

​
Create Invoice

POST /api/invoices

{
  "merchantId": "clx...",
  "customerEmail": "customer@example.com",
  "customerName": "John Doe",
  "items": [
    {
      "description": "Consulting Services",
      "quantity": 1,
      "unitPrice": 500.00,
      "taxable": true
    }
  ],
  "taxRate": 8.5,
  "paymentTerms": "NET_30",
  "memo": "Thank you for your business",
  "template": "MODERN"
}

​
Send Invoice

POST /api/invoices/:id/send
Sends the invoice to the customer via email with a hosted payment link.

​
Void Invoice

POST /api/invoices/:id/void

​
Invoice Settings

GET /api/invoices/settings
PATCH /api/invoices/settings
Configure defaults: branding, tax rate, payment terms, late fees, reminders, numbering.