Mayson Monorepo Documentation
    Preparing search index...

    Interface SubscriptionItemDeleteParams

    interface SubscriptionItemDeleteParams {
        clear_usage?: boolean;
        proration_behavior?: Stripe.SubscriptionItemDeleteParams.ProrationBehavior;
        proration_date?: number;
    }
    Index

    Properties

    clear_usage?: boolean

    Delete all usage for the given subscription item. Allowed only when the current plan's usage_type is metered.

    Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item's quantity changes. The default value is create_prorations.

    proration_date?: number

    If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint.