InvoiceLine
- balanceType: integer
Amount min:0requiredWhat's still to pay on the line:
totalPriceAfterTaxless what's been allocated to it, and 0 once the invoice is paid. The most you can allocate to it. Integer minor units (cents for USD). - createdType: stringFormat: date-time
At requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- creditedType: integer
Amount requiredAlways 0. Credit notes refund the invoice as a whole; see the invoice's
creditNotesTotal. Integer minor units (cents for USD). - currencyType: stringrequired
Three-letter ISO 4217 code, upper case.
- descriptionType: stringrequired
What the line is for, as your customer sees it.
- endType: stringFormat: date-time
Date requiredEnd of the period the line covers, exclusive.
- idType: stringrequired
The line's ID, the invoice's ID, a hyphen and the line's position from 0. Allocate payments to it by this ID.
- orderType: string | null
Id requiredThe order the invoice bills.
- orderType: string | null
Line Attribute Id requiredThe charge on that order line this invoice line bills (
orderLineAttributeIdin Get amendment options); null for a line that doesn't come from one. - orderType: string | null
Line Id requiredThe order line this invoice line bills; null for a line that doesn't come from one, such as on an invoice Stripe issued.
- paymentType: stringenum
Status requiredpaidwhen nothing is left to pay on the line; otherwiseoverduewhen the invoice is overdue,partiallyPaidwhen some of it is paid, andpendingwhen none is.valuespendingpartiallyPaidpaidoverdue - quantityType: integerrequired
How many units the line bills.
- startType: stringFormat: date-time
Date requiredStart of the period the line covers, inclusive: the period of the charge it bills, which can differ from the invoice's (a fee billed in advance covers the period it pays for; usage covers the period it was used in). A one-time fee's line, and a percentage-of-total charge's, starts and ends at the moment it was billed. A line without a period of its own, such as on an invoice Stripe issued, takes the invoice's.
- taxType: integerrequired
The line's tax, at the invoice's tax rate, rounded to the minor unit. Integer minor units (cents for USD).
- taxType: number
Rate requiredThe invoice's tax rate, as a fraction (0.08 is 8%).
- totalType: integer
Price After Tax requiredThe line's amount including tax. Integer minor units (cents for USD).
- totalType: integer
Price Before Tax requiredThe line's amount before tax; negative for a discount line. Integer minor units (cents for USD).
- updatedType: stringFormat: date-time
At requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z