Mayson Monorepo Documentation
    Preparing search index...
    interface Item {
        billing_thresholds?: Emptyable<
            Stripe.SubscriptionUpdateParams.Item.BillingThresholds,
        >;
        clear_usage?: boolean;
        deleted?: boolean;
        discounts?: Emptyable<Stripe.SubscriptionUpdateParams.Item.Discount[]>;
        id?: string;
        metadata?: Emptyable<MetadataParam>;
        plan?: string;
        price?: string;
        price_data?: Stripe.SubscriptionUpdateParams.Item.PriceData;
        quantity?: number;
        tax_rates?: Emptyable<string[]>;
    }
    Index

    Properties

    Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

    clear_usage?: boolean

    Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. clear_usage has no effect if the plan has a billing meter attached.

    deleted?: boolean

    A flag that, if set to true, will delete the specified item.

    The coupons to redeem into discounts for the subscription item.

    id?: string

    Subscription item to update.

    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.

    plan?: string

    Plan ID for this item, as a string.

    price?: string

    The ID of the price object. One of price or price_data is required. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided.

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

    quantity?: number

    Quantity for this item.

    tax_rates?: Emptyable<string[]>

    A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.