Skip to main content

Invoice series model for API responses

$entity
enum<string>
required
Available options:
invoice_series
id
string
required
status
enum<string>
required
Available options:
active,
ended,
cancelled
recurrenceRule
InvoiceSeriesRecurrenceRule · object
required

Discriminated union defining when a recurring invoice series issues invoices

paymentTermsDays
integer
required
invoiceTz
string
required
startDate
string<date-time>
required
endCondition
InvoiceSeriesEndCondition · object
required

Discriminated union defining when a recurring invoice series stops generating invoices

template
InvoiceSeriesTemplate · object
required

Template data used to generate each invoice in a recurring series

paymentMethods
InvoiceSlashPaymentMethod · object[]
required
accountId
string
required
nextScheduledDate
string<date-time> | null