{
"$entity": "invoice_series",
"id": "<string>",
"recurrenceRule": {
"type": "weekly",
"dayOfWeek": 3
},
"paymentTermsDays": 123,
"invoiceTz": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endCondition": {
"type": "never"
},
"template": {
"lineItemsAndTotals": {
"lineItems": [
{
"name": "<string>",
"quantity": 123,
"priceCents": 123,
"catalogItemId": "<string>"
}
],
"discount": {
"type": "percentage",
"percent": 123
},
"tax": {
"type": "percentage",
"percent": 123
}
},
"memo": "<string>",
"ccEmails": [
"<string>"
]
},
"paymentMethods": [
{
"method": "ach_debit",
"config": {
"passFeeToPayer": true
}
}
],
"accountId": "<string>",
"nextScheduledDate": "2023-11-07T05:31:56Z",
"legalEntityContactId": "<string>",
"legalEntityCustomerId": "<string>"
}Entities
Invoice Series
Invoice series model for API responses
Available options:
invoice_series Available options:
active, ended, cancelled Discriminated union defining when a recurring invoice series issues invoices
- InvoiceSeriesRecurrenceRule
- InvoiceSeriesRecurrenceRule
- InvoiceSeriesRecurrenceRule
Show child attributes
Show child attributes
Discriminated union defining when a recurring invoice series stops generating invoices
- InvoiceSeriesEndCondition
- InvoiceSeriesEndCondition
- InvoiceSeriesEndCondition
Show child attributes
Show child attributes
Template data used to generate each invoice in a recurring series
Show child attributes
Show child attributes
paymentMethods
(PaymentMethodAchDebit · object | PaymentMethodCardPayment · object | PaymentMethodCryptoDeposit · object | PaymentMethodInboundAchTransfer · object | PaymentMethodInboundInternationalWire · object | PaymentMethodInboundRtp · object | PaymentMethodInboundWireTransfer · object)[]
required
- PaymentMethodAchDebit
- PaymentMethodCardPayment
- PaymentMethodCryptoDeposit
- PaymentMethodInboundAchTransfer
- PaymentMethodInboundInternationalWire
- PaymentMethodInboundRtp
- PaymentMethodInboundWireTransfer
Show child attributes
Show child attributes
⌘I