InvoiceTenantBreakdownResponse

  • currency
    Type: string
    required
  • invoice_id
    Type: string
    required
  • lines
    Type: array of InvoiceLineDetail
    required

    Every line on the invoice, in Stripe's order, whether or not it reached a tenant. Capped — check lines_truncated before reconciling line by line.

    Properties: 7
  • lines_truncated
    Type: boolean
    required

    True when the invoice carried more lines than this response returns. The tenant amounts and unallocated_cents are computed from every line either way and remain exact; only lines is shortened.

  • tenants
    Type: array of InvoiceTenantBreakdownRow
    required

    Highest amount first. Empty when no line maps to a tenant.

    Properties: 4
  • total_cents
    Type: integer
    required

    Invoice total in the smallest currency unit (cents for USD). Stripe does not reduce this when a credit note is issued against a finalized invoice.

  • unallocated_cents
    Type: integer
    required

    Total minus everything attributable to a tenant: one-off charges, lines with no matching tenant, and invoice-level discounts, credits and tax. Can be negative when a credit exceeds the unattributed lines.

  • status
    Type: stringnullable

    The invoice's Stripe status. A void or uncollectible invoice splits across tenants exactly like a live one, but the underlying bill is not owed and must not be re-issued.