Mayson Monorepo Documentation
    Preparing search index...

    Invoice Items represent the component lines of an invoice. When you create an invoice item with an invoice field, it is attached to the specified invoice and included as an invoice line item within invoice.lines.

    Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a subscription. Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.

    Related guides: Integrate with the Invoicing API, Subscription Invoices.

    interface InvoiceItem {
        id: string;
        object: "invoiceitem";
        amount: number;
        currency: string;
        customer: string | Stripe.Customer | DeletedCustomer;
        customer_account: string;
        date: number;
        deleted?: void;
        description: string;
        discountable: boolean;
        discounts: (string | Stripe.Discount)[];
        invoice: string | Stripe.Invoice;
        livemode: boolean;
        metadata: Metadata;
        net_amount?: number;
        parent: Stripe.InvoiceItem.Parent;
        period: Stripe.InvoiceItem.Period;
        pricing: Stripe.InvoiceItem.Pricing;
        proration: boolean;
        proration_details?: Stripe.InvoiceItem.ProrationDetails;
        quantity: number;
        tax_rates: Stripe.TaxRate[];
        test_clock: string | Stripe.TestHelpers.TestClock;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "invoiceitem"

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

    amount: number

    Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.

    currency: string

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

    customer: string | Stripe.Customer | DeletedCustomer

    The ID of the customer to bill for this invoice item.

    customer_account: string

    The ID of the account to bill for this invoice item.

    date: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    deleted?: void

    Always true for a deleted object

    description: string

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

    discountable: boolean

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

    discounts: (string | Stripe.Discount)[]

    The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

    invoice: string | Stripe.Invoice

    The ID of the invoice this invoice item belongs to.

    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.

    net_amount?: number

    The amount after discounts, but before credits and taxes. This field is null for discountable=true items.

    The parent that generated this invoice item.

    The pricing information of the invoice item.

    proration: boolean

    Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.

    proration_details?: Stripe.InvoiceItem.ProrationDetails
    quantity: number

    Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.

    tax_rates: Stripe.TaxRate[]

    The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.

    test_clock: string | Stripe.TestHelpers.TestClock

    ID of the test clock this invoice item belongs to.