idstring uuid required
The unique identifier for the invoice.
customer_idstring uuid required
The unique identifier for the customer.
status'Draft' | 'Open' | 'Pending' | 'Scheduled' | 'Partially Paid' | 'Paid' | 'Canceled' | 'Expired' | 'Overdue' required
amountstring required
The total amount of the invoice.
amount_paidstring required
The amount that has been paid on the invoice.
amount_duestring required
The remaining amount due on the invoice.
invoice_numberstring nullable
The public-facing invoice number.
line_item_idsstring[] required
List of line item IDs associated with the invoice.
payment_method_typesPaymentMethodType[] required
List of allowed payment method types for the invoice.
send_email_on_creationboolean required
Whether to send an email upon invoice creation.
additional_recipient_emailsstring[] required
List of additional email addresses to receive the invoice.
notestring nullable
A note associated with the invoice.
collection_account_idstring uuid required
The collection account ID where funds will be collected.
created_atstring date-time required
ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).
updated_atstring date-time
ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).
paid_atstring date-time
ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).
canceled_atstring date-time
ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).
sent_atstring date-time
ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).
expired_atstring date-time
ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).