Mayson Monorepo Documentation
    Preparing search index...
    interface Item {
        billing_thresholds?: Emptyable<
            Stripe.SubscriptionScheduleCreateParams.Phase.Item.BillingThresholds,
        >;
        discounts?: Emptyable<
            Stripe.SubscriptionScheduleCreateParams.Phase.Item.Discount[],
        >;
        metadata?: MetadataParam;
        plan?: string;
        price?: string;
        price_data?: Stripe.SubscriptionScheduleCreateParams.Phase.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.

    The coupons to redeem into discounts for the subscription item.

    metadata?: MetadataParam

    Set of key-value pairs that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's metadata when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's metadata can be unset by posting an empty value to them in the configuration item's metadata. To unset all keys in the subscription item's metadata, update the subscription item directly or unset every key individually from the configuration item's metadata.

    plan?: string

    The plan ID to subscribe to. You may specify the same ID in plan and price.

    price?: string

    The ID of the price object.

    Data used to generate a new Price object inline.

    quantity?: number

    Quantity for the given price. Can be set only if the price's usage_type is licensed and not metered.

    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.