# Recurring Invoices

Recurring invoice schedules that generate invoices automatically on a cadence.

**Base URL:** `https://api.trustpager.com/functions/v1/api/v1`

## Endpoints

### POST /recurring-invoices

Set up a recurring invoice: pick a schedule (interval_unit week|month|year + interval_count) and line_items, optionally linked to an opportunity/contact. Each period TrustPager generates a fresh native invoice, attaches a Stripe 'Pay now' link (attach_payment_link, needs Stripe connected), and emails it (auto_send). Optional end_date or max_occurrences stop the series. Starts active by default.

**Scopes:** `recurring_invoices:write` — [full detail](./recurring-invoices/post-recurring-invoices.md)

### DELETE /recurring-invoices/:recurring_invoice_id

Stop a recurring invoice schedule permanently (no more invoices are generated). Already-generated invoices are kept. Destructive.

**Scopes:** `recurring_invoices:write` — [full detail](./recurring-invoices/delete-recurring-invoices-recurring-invoice-id.md)

### GET /recurring-invoices/:recurring_invoice_id

Fetch one recurring invoice schedule by UUID, including its template line items, next run date, and how many invoices it has generated.

**Scopes:** `recurring_invoices:read` — [full detail](./recurring-invoices/get-recurring-invoices-recurring-invoice-id.md)

### GET /recurring-invoices

List recurring invoice schedules. Filter by status (active|paused|stopped|completed) or opportunity_id. Each schedule auto-generates a native invoice every period.

**Scopes:** `recurring_invoices:read` — [full detail](./recurring-invoices/get-recurring-invoices.md)

### PATCH /recurring-invoices/:recurring_invoice_id

Update a recurring invoice schedule (line items, interval, dates, toggles) OR change its status to pause/resume/stop it. status='paused' stops generating, status='active' resumes, status='stopped' ends it. Pass only the fields you want to change.

**Scopes:** `recurring_invoices:write` — [full detail](./recurring-invoices/patch-recurring-invoices-recurring-invoice-id.md)