InvoiceLineDetail

One line of the invoice, and why it did or did not reach a tenant. Present on every breakdown response, so an invoice that splits cleanly and one that attributes to nobody are read the same way.

  • amount_cents
    Type: integer
    required

    This line's amount in the smallest currency unit. Negative for credits and discounts applied as their own line.

  • description
    Type: stringnullable

    Stripe's description for the line, as it appears on the PDF

  • period_end
    Type: stringFormat: date-timenullable

    End of the period this line covers (UTC)

  • period_start
    Type: stringFormat: date-timenullable

    Start of the period this line covers (UTC)

  • quantity
    Type: integernullable

    Units billed on this line, e.g. seats

  • tenant_entity_id
    Type: stringnullable

    The tenant this line was attributed to, or null when it landed in unallocated_cents. Exactly one of this and unallocated_reason is ever set.

  • unallocated_reason
    Type: "no_subscription_item" or "unmapped_subscription_item"enumnullable

    Why this line is not attributed to a tenant. no_subscription_item — not tied to a subscription item; one-off charges, credits and inline tax genuinely have no tenant, but metered usage and overage lines also land here and often name a tenant in their description. unmapped_subscription_item — tied to one, but no license on your account holds that item. Null when attributed, so exactly one of this and tenant_entity_id is ever set.