Mayson Monorepo Documentation
    Preparing search index...
    interface InvoiceItem {
        amount?: number;
        currency?: string;
        description?: string;
        discountable?: boolean;
        discounts?: Emptyable<
            Stripe.InvoiceCreatePreviewParams.InvoiceItem.Discount[],
        >;
        invoiceitem?: string;
        metadata?: Emptyable<MetadataParam>;
        period?: Stripe.InvoiceCreatePreviewParams.InvoiceItem.Period;
        price?: string;
        price_data?: Stripe.InvoiceCreatePreviewParams.InvoiceItem.PriceData;
        quantity?: number;
        tax_behavior?: Stripe.InvoiceCreatePreviewParams.InvoiceItem.TaxBehavior;
        tax_code?: string;
        tax_rates?: Emptyable<string[]>;
        unit_amount?: number;
        unit_amount_decimal?: string;
    }
    Index

    Properties

    amount?: number

    The integer amount in cents (or local equivalent) of previewed invoice item.

    currency?: string

    Three-letter ISO currency code, in lowercase. Must be a supported currency. Only applicable to new invoice items.

    description?: string

    An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

    discountable?: boolean

    Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.

    The coupons to redeem into discounts for the invoice item in the preview.

    invoiceitem?: string

    The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

    price?: string

    The ID of the price object. One of price or price_data is required.

    Data used to generate a new Price object inline. One of price or price_data is required.

    quantity?: number

    Non-negative integer. The quantity of units for the invoice item.

    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

    tax_code?: string

    A tax code ID.

    tax_rates?: Emptyable<string[]>

    The tax rates that apply to the item. When set, any default_tax_rates do not apply to this item.

    unit_amount?: number

    The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.

    unit_amount_decimal?: string

    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.