InvoicePage

View as Markdown

Fields

invoicesarray ofobjectrequired
Newest period first.
19 properties
- idstringrequired
- numberstring | nullrequired
  Assigned when the invoice is issued.
- statusstringrequired
  open, paid, void or uncollectible. Treat other values as unknown.
- overduebooleanrequired
  Open, not carried forward, and past its due date.
- carriedForwardbooleanrequired
  Below the minimum charge: added to the next invoice instead.
- carriedIntoInvoiceIdstring | nullrequired
  The invoice it was carried into, once there is one.
- periodStartstringrequired
  format: date-time
- periodEndstringrequired
  format: date-time
- currencystringrequired
- collectionMethodstring | nullrequired
  charge_automatically (the default card) or send_invoice.
- totalCentsstringrequired
  Cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- startingBalanceCentsstringrequired
  Carried from earlier invoices, in cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- amountDueCentsstringrequired
  Cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- amountPaidCentsstringrequired
  Cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- amountRemainingCentsstringrequired
  Cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- dueAtstring | nullrequired
  format: date-time
- issuedAtstring | nullrequired
  When it was issued and numbered.
  
  format: date-time
- finalizedAtstring | nullrequired
  The same as issuedAt.
  
  format: date-time
- paidAtstring | nullrequired
  format: date-time
nextCursorstring | nullrequired
Pass as cursor for the next page; null on the last.