stripe 19.4.0-alpha.1 → 19.4.0-alpha.2

package/types/Quotes.d.ts

@@ -803,6 +803,16 @@ declare module 'stripe' {
          * Integer representing the number of trial period days before the customer is charged for the first time.
          */
         trial_period_days: number | null;
+
+        /**
+         * Billing schedules that will be applied to the subscription or subscription schedule created from this quote.
+         */
+        billing_schedules?: Array<SubscriptionData.BillingSchedule> | null;
+
+        /**
+         * Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
+         */
+        phase_effective_at?: SubscriptionData.PhaseEffectiveAt | null;
       }
 
       namespace SubscriptionData {
@@ -832,6 +842,187 @@ declare module 'stripe' {
           type Type = 'classic' | 'flexible';
         }
 
+        interface BillingSchedule {
+          /**
+           * Specifies which subscription items the billing schedule applies to.
+           */
+          applies_to: Array<BillingSchedule.AppliesTo> | null;
+
+          /**
+           * Specifies the billing period.
+           */
+          bill_until: BillingSchedule.BillUntil;
+
+          /**
+           * Unique identifier for the billing schedule.
+           */
+          key: string;
+
+          /**
+           * Specifies the start of the billing period.
+           */
+          bill_from?: BillingSchedule.BillFrom | null;
+        }
+
+        namespace BillingSchedule {
+          interface AppliesTo {
+            /**
+             * The billing schedule will apply to the subscription item with the given price ID.
+             */
+            price: string | Stripe.Price | null;
+
+            /**
+             * Controls which subscription items the billing schedule applies to.
+             */
+            type: 'price';
+          }
+
+          interface BillFrom {
+            /**
+             * Use an index to specify the position of an amendment to start prebilling with.
+             */
+            amendment_start: BillFrom.AmendmentStart | null;
+
+            /**
+             * The time the billing schedule applies from.
+             */
+            computed_timestamp: number | null;
+
+            /**
+             * Lets you bill the period starting from a particular Quote line.
+             */
+            line_starts_at: BillFrom.LineStartsAt | null;
+
+            /**
+             * Timestamp is calculated from the request time.
+             */
+            relative: BillFrom.Relative | null;
+
+            /**
+             * Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
+             */
+            timestamp: number | null;
+
+            /**
+             * Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
+             */
+            type: BillFrom.Type;
+          }
+
+          namespace BillFrom {
+            interface AmendmentStart {
+              /**
+               * Use an index to specify the position of an amendment to start prebilling with.
+               */
+              index: number;
+            }
+
+            interface LineStartsAt {
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+            }
+
+            interface Relative {
+              /**
+               * Specifies billing duration. Possible values are `day`, `week`, `month`, or `year`.
+               */
+              interval: Relative.Interval;
+
+              /**
+               * The multiplier applied to the interval.
+               */
+              interval_count: number | null;
+            }
+
+            namespace Relative {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+
+            type Type =
+              | 'amendment_start'
+              | 'line_starts_at'
+              | 'now'
+              | 'pause_collection_start'
+              | 'quote_acceptance_date'
+              | 'relative'
+              | 'timestamp';
+          }
+
+          interface BillUntil {
+            /**
+             * The timestamp the billing schedule will apply until.
+             */
+            computed_timestamp: number;
+
+            /**
+             * Specifies the billing period.
+             */
+            duration: BillUntil.Duration | null;
+
+            /**
+             * If specified, the billing schedule will apply until the specified timestamp.
+             */
+            timestamp: number | null;
+
+            /**
+             * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+             */
+            type: BillUntil.Type;
+
+            /**
+             * Use an index to specify the position of an amendment to end prebilling with.
+             */
+            amendment_end?: BillUntil.AmendmentEnd | null;
+
+            /**
+             * Lets you bill the period ending at a particular Quote line.
+             */
+            line_ends_at?: BillUntil.LineEndsAt | null;
+          }
+
+          namespace BillUntil {
+            interface AmendmentEnd {
+              /**
+               * Use an index to specify the position of an amendment to end prebilling with.
+               */
+              index: number;
+            }
+
+            interface Duration {
+              /**
+               * Specifies billing duration. Either `day`, `week`, `month` or `year`.
+               */
+              interval: Duration.Interval;
+
+              /**
+               * The multiplier applied to the interval.
+               */
+              interval_count: number | null;
+            }
+
+            namespace Duration {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+
+            interface LineEndsAt {
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+            }
+
+            type Type =
+              | 'amendment_end'
+              | 'duration'
+              | 'line_ends_at'
+              | 'schedule_end'
+              | 'timestamp'
+              | 'upcoming_invoice';
+          }
+        }
+
         interface BillOnAcceptance {
           /**
            * The start of the period to bill from when the Quote is accepted.
@@ -945,6 +1136,8 @@ declare module 'stripe' {
 
         type EndBehavior = 'cancel' | 'release';
 
+        type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
+
         interface Prebilling {
           iterations: number;
         }
@@ -987,6 +1180,18 @@ declare module 'stripe' {
          * Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the quote is accepted.
          */
         proration_behavior?: SubscriptionDataOverride.ProrationBehavior | null;
+
+        /**
+         * Billing schedules that will be applied to the subscription or subscription schedule created from this quote.
+         */
+        billing_schedules?: Array<
+          SubscriptionDataOverride.BillingSchedule
+        > | null;
+
+        /**
+         * Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
+         */
+        phase_effective_at?: SubscriptionDataOverride.PhaseEffectiveAt | null;
       }
 
       namespace SubscriptionDataOverride {
@@ -1013,6 +1218,187 @@ declare module 'stripe' {
 
         type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
 
+        interface BillingSchedule {
+          /**
+           * Specifies which subscription items the billing schedule applies to.
+           */
+          applies_to: Array<BillingSchedule.AppliesTo> | null;
+
+          /**
+           * Specifies the billing period.
+           */
+          bill_until: BillingSchedule.BillUntil;
+
+          /**
+           * Unique identifier for the billing schedule.
+           */
+          key: string;
+
+          /**
+           * Specifies the start of the billing period.
+           */
+          bill_from?: BillingSchedule.BillFrom | null;
+        }
+
+        namespace BillingSchedule {
+          interface AppliesTo {
+            /**
+             * The billing schedule will apply to the subscription item with the given price ID.
+             */
+            price: string | Stripe.Price | null;
+
+            /**
+             * Controls which subscription items the billing schedule applies to.
+             */
+            type: 'price';
+          }
+
+          interface BillFrom {
+            /**
+             * Use an index to specify the position of an amendment to start prebilling with.
+             */
+            amendment_start: BillFrom.AmendmentStart | null;
+
+            /**
+             * The time the billing schedule applies from.
+             */
+            computed_timestamp: number | null;
+
+            /**
+             * Lets you bill the period starting from a particular Quote line.
+             */
+            line_starts_at: BillFrom.LineStartsAt | null;
+
+            /**
+             * Timestamp is calculated from the request time.
+             */
+            relative: BillFrom.Relative | null;
+
+            /**
+             * Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
+             */
+            timestamp: number | null;
+
+            /**
+             * Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
+             */
+            type: BillFrom.Type;
+          }
+
+          namespace BillFrom {
+            interface AmendmentStart {
+              /**
+               * Use an index to specify the position of an amendment to start prebilling with.
+               */
+              index: number;
+            }
+
+            interface LineStartsAt {
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+            }
+
+            interface Relative {
+              /**
+               * Specifies billing duration. Possible values are `day`, `week`, `month`, or `year`.
+               */
+              interval: Relative.Interval;
+
+              /**
+               * The multiplier applied to the interval.
+               */
+              interval_count: number | null;
+            }
+
+            namespace Relative {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+
+            type Type =
+              | 'amendment_start'
+              | 'line_starts_at'
+              | 'now'
+              | 'pause_collection_start'
+              | 'quote_acceptance_date'
+              | 'relative'
+              | 'timestamp';
+          }
+
+          interface BillUntil {
+            /**
+             * The timestamp the billing schedule will apply until.
+             */
+            computed_timestamp: number;
+
+            /**
+             * Specifies the billing period.
+             */
+            duration: BillUntil.Duration | null;
+
+            /**
+             * If specified, the billing schedule will apply until the specified timestamp.
+             */
+            timestamp: number | null;
+
+            /**
+             * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+             */
+            type: BillUntil.Type;
+
+            /**
+             * Use an index to specify the position of an amendment to end prebilling with.
+             */
+            amendment_end?: BillUntil.AmendmentEnd | null;
+
+            /**
+             * Lets you bill the period ending at a particular Quote line.
+             */
+            line_ends_at?: BillUntil.LineEndsAt | null;
+          }
+
+          namespace BillUntil {
+            interface AmendmentEnd {
+              /**
+               * Use an index to specify the position of an amendment to end prebilling with.
+               */
+              index: number;
+            }
+
+            interface Duration {
+              /**
+               * Specifies billing duration. Either `day`, `week`, `month` or `year`.
+               */
+              interval: Duration.Interval;
+
+              /**
+               * The multiplier applied to the interval.
+               */
+              interval_count: number | null;
+            }
+
+            namespace Duration {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+
+            interface LineEndsAt {
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+            }
+
+            type Type =
+              | 'amendment_end'
+              | 'duration'
+              | 'line_ends_at'
+              | 'schedule_end'
+              | 'timestamp'
+              | 'upcoming_invoice';
+          }
+        }
+
         interface BillOnAcceptance {
           /**
            * The start of the period to bill from when the Quote is accepted.
@@ -1126,6 +1512,8 @@ declare module 'stripe' {
 
         type EndBehavior = 'cancel' | 'release';
 
+        type PhaseEffectiveAt = 'billing_period_start' | 'phase_start';
+
         type ProrationBehavior =
           | 'always_invoice'
           | 'create_prorations'