Mayson Monorepo Documentation
    Preparing search index...

    Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.

    interface SubscriptionItem {
        id: string;
        object: "subscription_item";
        billing_thresholds: Stripe.SubscriptionItem.BillingThresholds;
        created: number;
        current_period_end: number;
        current_period_start: number;
        deleted?: void;
        discounts: (string | Stripe.Discount)[];
        metadata: Metadata;
        plan: Stripe.Plan;
        price: Stripe.Price;
        quantity?: number;
        subscription: string;
        tax_rates: Stripe.TaxRate[];
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "subscription_item"

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

    Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period

    created: number

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

    current_period_end: number

    The end time of this subscription item's current billing period.

    current_period_start: number

    The start time of this subscription item's current billing period.

    deleted?: void

    Always true for a deleted object

    discounts: (string | Stripe.Discount)[]

    The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.

    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.

    plan: Stripe.Plan

    You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

    Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.

    For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.

    Related guides: Set up a subscription and more about products and prices.

    price: Stripe.Price

    Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

    For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.

    Related guides: Set up a subscription, create an invoice, and more about products and prices.

    quantity?: number

    The quantity of the plan to which the customer should be subscribed.

    subscription: string

    The subscription this subscription_item belongs to.

    tax_rates: Stripe.TaxRate[]

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