Mayson Monorepo Documentation
    Preparing search index...

    Interface SubscriptionSchedule

    A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.

    Related guide: Subscription schedules

    interface SubscriptionSchedule {
        id: string;
        object: "subscription_schedule";
        application: string | Application | DeletedApplication;
        billing_mode: Stripe.SubscriptionSchedule.BillingMode;
        canceled_at: number;
        completed_at: number;
        created: number;
        current_phase: CurrentPhase;
        customer: string | Stripe.Customer | DeletedCustomer;
        customer_account: string;
        default_settings: Stripe.SubscriptionSchedule.DefaultSettings;
        end_behavior: Stripe.SubscriptionSchedule.EndBehavior;
        livemode: boolean;
        metadata: Metadata;
        phases: Stripe.SubscriptionSchedule.Phase[];
        released_at: number;
        released_subscription: string;
        status: Stripe.SubscriptionSchedule.Status;
        subscription: string | Stripe.Subscription;
        test_clock: string | Stripe.TestHelpers.TestClock;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "subscription_schedule"

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

    application: string | Application | DeletedApplication

    ID of the Connect Application that created the schedule.

    The billing mode of the subscription.

    canceled_at: number

    Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

    completed_at: number

    Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

    created: number

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

    current_phase: CurrentPhase

    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.

    customer: string | Stripe.Customer | DeletedCustomer

    ID of the customer who owns the subscription schedule.

    customer_account: string

    ID of the account who owns the subscription schedule.

    Behavior of the subscription schedule and underlying subscription when it ends. Possible values are release or cancel with the default being release. release will end the subscription schedule and keep the underlying subscription running. cancel will end the subscription schedule and cancel the underlying subscription.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    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.

    Configuration for the subscription schedule's phases.

    released_at: number

    Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

    released_subscription: string

    ID of the subscription once managed by the subscription schedule (if it is released).

    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.

    subscription: string | Stripe.Subscription

    ID of the subscription managed by the subscription schedule.

    test_clock: string | Stripe.TestHelpers.TestClock

    ID of the test clock this subscription schedule belongs to.