v1

latestOpenAPI 3.0.02026-08-068926279.2 KB

Recurring Invoices

Get a recurring invoice

Returns a specific recurring invoice template

get/invoices/recurring/{id}

Path parameters

idinteger required

Recurring Invoice ID

Response

Successful response

idinteger

client_idinteger nullable

project_idinteger nullable

document_idstring

po_numberstring nullable

subjectstring nullable

payment_dueinteger

start_datestring date nullable

end_datestring date nullable

frequency'Weekly' | 'Bi-Weekly' | 'Monthly' | 'Quarterly' | 'Yearly'

delivery'send' | 'draft'

shippingnumber

discountnumber

subtotalnumber

totalnumber

notestring nullable

auto_billingboolean

has_auto_billing_customerboolean

auto_billsboolean

stripe_payment_methodstring nullable

online_paymentboolean

accept_achboolean

line_item_optionsstring[]

next_invoice_datestring date-time nullable

Example response

{
  "id": 1,
  "client_id": 1,
  "project_id": 1,
  "document_id": "REC-001",
  "payment_due": 30,
  "frequency": "Monthly",
  "delivery": "send",
  "subtotal": 1500,
  "total": 1500,
  "online_payment": true
}