Create Recurring Schedule

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
namestringRequired

Required: Schedule name - max 255 chars - “Monthly Maintenance Plan”

end_datestringRequired

Optional: Schedule end date - date, must be after start_date - “2027-03-31”

frequencystringRequired

Required: Billing frequency - weekly|biweekly|monthly|quarterly|semiannual|annual - “monthly”

start_datestringRequired

Required: Schedule start date - date, must be today or future - “2026-04-01”

customer_idstringRequired

Required: Customer ID - must exist in customers table - “{{customer_id}}

payment_termsstringRequired

Optional: Payment terms - due_on_receipt|net_15|net_30|net_45|net_60|custom - “net_30”

internal_notesstringRequired

Optional: Internal notes - max 2000 chars - “Premium customer plan”

invoice_amountstringRequired

Required: Total invoice amount - numeric min:0.01 - 500.00

auto_send_invoicestringRequired

Optional: Auto-send generated invoices - boolean - true

customer_notes_templatestringRequired

Optional: Customer notes template - max 2000 chars - “Recurring monthly maintenance”

line_items_template[0][quantity]stringRequired

Required: Template quantity - numeric min:0.0001 - 1

line_items_template[0][is_taxable]stringRequired

Optional: Whether item is taxable - boolean - true

line_items_template[0][unit_price]stringRequired

Required: Template unit price - numeric min:0 - 500.00

line_items_template[0][description]stringRequired

Required: Template line item description - max 500 chars - “Monthly HVAC Maintenance”

line_items_template[0][line_item_type]stringRequired

Optional: Line item type - max 50 chars - “service”

Response

Successful response