Mayson Monorepo Documentation
    Preparing search index...

    Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.

    Each line item is backed by either an invoice item or a subscription item.

    interface InvoiceLineItem {
        id: string;
        object: "line_item";
        amount: number;
        currency: string;
        description: string;
        discount_amounts: Stripe.InvoiceLineItem.DiscountAmount[];
        discountable: boolean;
        discounts: (string | Stripe.Discount)[];
        invoice: string;
        livemode: boolean;
        metadata: Metadata;
        parent: Stripe.InvoiceLineItem.Parent;
        period: Stripe.InvoiceLineItem.Period;
        pretax_credit_amounts: Stripe.InvoiceLineItem.PretaxCreditAmount[];
        pricing: Stripe.InvoiceLineItem.Pricing;
        quantity: number;
        subscription: string | Stripe.Subscription;
        subtotal: number;
        taxes: Stripe.InvoiceLineItem.Tax[];
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "line_item"

    String representing the object's type. Objects of the same type share the same value.

    amount: number

    The amount, in cents (or local equivalent).

    currency: string

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    description: string

    An arbitrary string attached to the object. Often useful for displaying to users.

    The amount of discount calculated per discount for this line item.

    discountable: boolean

    If true, discounts will apply to this line item. Always false for prorations.

    discounts: (string | Stripe.Discount)[]

    The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

    invoice: string

    The ID of the invoice that contains this line item.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    metadata: Metadata

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with type=subscription, metadata reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.

    The parent that generated this line item.

    pretax_credit_amounts: Stripe.InvoiceLineItem.PretaxCreditAmount[]

    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.

    The pricing information of the line item.

    quantity: number

    The quantity of the subscription, if the line item is a subscription or a proration.

    subscription: string | Stripe.Subscription
    subtotal: number

    The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes.

    The tax information of the line item.