recurring_create
Create a recurring invoice schedule that automatically issues invoices at a specified frequency, with optional auto-finalization, end dates, and occurrence limits.
Instructions
Set up a schedule that issues invoices on its own.
Starts active, so the first invoice is issued when the schedule next
falls due. The invoices it produces are ordinary documents — read them with
list_generated_invoices.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | Stop generating after this date | |
| interval | No | Every N periods | |
| frequency | Yes | daily, weekly, monthly, quarterly, or yearly | |
| start_date | Yes | Date of the first invoice | |
| customer_id | Yes | ||
| auto_finalize | No | Automatically finalize generated invoices | |
| max_occurrences | No | Stop after N invoices | |
| invoice_template | Yes | Invoice payload used as template for each occurrence | |
| business_profile_id | Yes | ||
| numbering_sequence_id | No | Auto-generate invoice numbers from this sequence |