UpcomingInvoice

The open period's invoice as it stands: an estimate until the period closes.

View as Markdown

Fields

organizationIdstringrequired
periodStartstringrequired
format: date-time
periodEndstringrequired
format: date-time
issuesAtstringrequired
format: date-time
currencystringrequired
estimatedbooleanrequired
subtotalMicrosstringrequired
Micros.

pattern: ^-?[0-9]+(\.[0-9]+)?$
totalCentsstringrequired
Cents.

pattern: ^-?[0-9]+(\.[0-9]+)?$
roundingMicrosstringrequired
Micros.

pattern: ^-?[0-9]+(\.[0-9]+)?$
linesarray ofobjectrequired
13 properties
- positionintegerrequired
- kindstringrequired
  usage, other_usage (lines under half a cent) or other_projects (a service's smallest projects, past the line limit).
- servicestring | nullrequired
- projectIdstring | nullrequired
- projectNamestring | nullrequired
  The project's name when the invoice was drafted.
- projectSlugstring | nullrequired
- skustring | nullrequired
- descriptionstringrequired
- quantitystringrequired
  In the SKU's unit.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- unitPricestring | nullrequired
  Dollars per unit; null for folded lines and SKUs whose price changed within the period.
- amountstringrequired
  Exact dollars.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- amountMicrosstringrequired
  Micros.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$
- amountCentsstringrequired
  What's billed, in cents.
  
  pattern: ^-?[0-9]+(\.[0-9]+)?$