stripe 18.2.0-beta.1 → 18.2.1

package/types/SubscriptionSchedules.d.ts

@@ -27,16 +27,6 @@ declare module 'stripe' {
         | Stripe.DeletedApplication
         | null;
 
-      /**
-       * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
-       */
-      billing_behavior?: SubscriptionSchedule.BillingBehavior;
-
-      /**
-       * The [billing mode](https://stripe.com/api/subscriptions/create#create_subscription-billing_mode) that will be used to process all future operations for the subscription schedule.
-       */
-      billing_mode?: SubscriptionSchedule.BillingMode;
-
       /**
        * Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
        */
@@ -62,11 +52,6 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
-      /**
-       * ID of the account who owns the subscription schedule.
-       */
-      customer_account?: string | null;
-
       default_settings: SubscriptionSchedule.DefaultSettings;
 
       /**
@@ -74,11 +59,6 @@ declare module 'stripe' {
        */
       end_behavior: SubscriptionSchedule.EndBehavior;
 
-      /**
-       * Details of the most recent price migration that failed for the subscription schedule.
-       */
-      last_price_migration_error?: SubscriptionSchedule.LastPriceMigrationError | null;
-
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
        */
@@ -94,11 +74,6 @@ declare module 'stripe' {
        */
       phases: Array<SubscriptionSchedule.Phase>;
 
-      /**
-       * Time period and invoice for a Subscription billed in advance.
-       */
-      prebilling?: SubscriptionSchedule.Prebilling | null;
-
       /**
        * Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
        */
@@ -126,10 +101,6 @@ declare module 'stripe' {
     }
 
     namespace SubscriptionSchedule {
-      type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
-
-      type BillingMode = 'classic' | 'flexible';
-
       interface CurrentPhase {
         /**
          * The end of this phase of the subscription schedule.
@@ -155,6 +126,11 @@ declare module 'stripe' {
          */
         billing_cycle_anchor: DefaultSettings.BillingCycleAnchor;
 
+        /**
+         * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
+         */
+        billing_thresholds: DefaultSettings.BillingThresholds | null;
+
         /**
          * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
          */
@@ -221,6 +197,18 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'automatic' | 'phase_start';
 
+        interface BillingThresholds {
+          /**
+           * Monetary threshold that triggers the subscription to create an invoice
+           */
+          amount_gte: number | null;
+
+          /**
+           * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
+           */
+          reset_billing_cycle_anchor: boolean | null;
+        }
+
         type CollectionMethod = 'charge_automatically' | 'send_invoice';
 
         interface InvoiceSettings {
@@ -272,37 +260,6 @@ declare module 'stripe' {
 
       type EndBehavior = 'cancel' | 'none' | 'release' | 'renew';
 
-      interface LastPriceMigrationError {
-        /**
-         * The time at which the price migration encountered an error.
-         */
-        errored_at: number;
-
-        /**
-         * The involved price pairs in each failed transition.
-         */
-        failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
-
-        /**
-         * The type of error encountered by the price migration.
-         */
-        type: 'price_uniqueness_violation';
-      }
-
-      namespace LastPriceMigrationError {
-        interface FailedTransition {
-          /**
-           * The original price to be migrated.
-           */
-          source_price: string;
-
-          /**
-           * The intended resulting price of the migration.
-           */
-          target_price: string;
-        }
-      }
-
       interface Phase {
         /**
          * A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
@@ -321,6 +278,11 @@ declare module 'stripe' {
          */
         billing_cycle_anchor: Phase.BillingCycleAnchor | null;
 
+        /**
+         * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
+         */
+        billing_thresholds: Phase.BillingThresholds | null;
+
         /**
          * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
          */
@@ -377,12 +339,7 @@ declare module 'stripe' {
         on_behalf_of: string | Stripe.Account | null;
 
         /**
-         * If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
-         */
-        pause_collection?: Phase.PauseCollection | null;
-
-        /**
-         * If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.
+         * When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
          */
         proration_behavior: Phase.ProrationBehavior;
 
@@ -396,20 +353,10 @@ declare module 'stripe' {
          */
         transfer_data: Phase.TransferData | null;
 
-        /**
-         * Specify behavior of the trial when crossing schedule phase boundaries
-         */
-        trial_continuation?: Phase.TrialContinuation | null;
-
         /**
          * When the trial ends within the phase.
          */
         trial_end: number | null;
-
-        /**
-         * Settings related to any trials on the subscription during this phase.
-         */
-        trial_settings?: Phase.TrialSettings | null;
       }
 
       namespace Phase {
@@ -447,30 +394,11 @@ declare module 'stripe' {
              */
             discount: string | Stripe.Discount | null;
 
-            /**
-             * Details to determine how long the discount should be applied for.
-             */
-            discount_end?: Discount.DiscountEnd | null;
-
             /**
              * ID of the promotion code to create a new discount for.
              */
             promotion_code: string | Stripe.PromotionCode | null;
           }
-
-          namespace Discount {
-            interface DiscountEnd {
-              /**
-               * The discount end timestamp.
-               */
-              timestamp: number | null;
-
-              /**
-               * The discount end type.
-               */
-              type: 'timestamp';
-            }
-          }
         }
 
         interface AutomaticTax {
@@ -510,6 +438,18 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'automatic' | 'phase_start';
 
+        interface BillingThresholds {
+          /**
+           * Monetary threshold that triggers the subscription to create an invoice
+           */
+          amount_gte: number | null;
+
+          /**
+           * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
+           */
+          reset_billing_cycle_anchor: boolean | null;
+        }
+
         type CollectionMethod = 'charge_automatically' | 'send_invoice';
 
         interface Discount {
@@ -523,31 +463,12 @@ declare module 'stripe' {
            */
           discount: string | Stripe.Discount | null;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd | null;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code: string | Stripe.PromotionCode | null;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * The discount end timestamp.
-             */
-            timestamp: number | null;
-
-            /**
-             * The discount end type.
-             */
-            type: 'timestamp';
-          }
-        }
-
         interface InvoiceSettings {
           /**
            * The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
@@ -586,6 +507,11 @@ declare module 'stripe' {
         }
 
         interface Item {
+          /**
+           * Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
+           */
+          billing_thresholds: Item.BillingThresholds | null;
+
           /**
            * The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
            */
@@ -615,14 +541,16 @@ declare module 'stripe' {
            * The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
            */
           tax_rates?: Array<Stripe.TaxRate> | null;
-
-          /**
-           * Options that configure the trial on the subscription item.
-           */
-          trial?: Item.Trial | null;
         }
 
         namespace Item {
+          interface BillingThresholds {
+            /**
+             * Usage threshold that triggers the subscription to create an invoice
+             */
+            usage_gte: number | null;
+          }
+
           interface Discount {
             /**
              * ID of the coupon to create a new discount for.
@@ -634,57 +562,11 @@ declare module 'stripe' {
              */
             discount: string | Stripe.Discount | null;
 
-            /**
-             * Details to determine how long the discount should be applied for.
-             */
-            discount_end?: Discount.DiscountEnd | null;
-
             /**
              * ID of the promotion code to create a new discount for.
              */
             promotion_code: string | Stripe.PromotionCode | null;
           }
-
-          namespace Discount {
-            interface DiscountEnd {
-              /**
-               * The discount end timestamp.
-               */
-              timestamp: number | null;
-
-              /**
-               * The discount end type.
-               */
-              type: 'timestamp';
-            }
-          }
-
-          interface Trial {
-            /**
-             * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
-             */
-            converts_to?: Array<string> | null;
-
-            /**
-             * Determines the type of trial for this item.
-             */
-            type: Trial.Type;
-          }
-
-          namespace Trial {
-            type Type = 'free' | 'paid';
-          }
-        }
-
-        interface PauseCollection {
-          /**
-           * The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
-           */
-          behavior: PauseCollection.Behavior;
-        }
-
-        namespace PauseCollection {
-          type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
         }
 
         type ProrationBehavior =
@@ -703,54 +585,6 @@ declare module 'stripe' {
            */
           destination: string | Stripe.Account;
         }
-
-        type TrialContinuation = 'continue' | 'none';
-
-        interface TrialSettings {
-          /**
-           * Defines how the subscription should behave when a trial ends.
-           */
-          end_behavior: TrialSettings.EndBehavior | null;
-        }
-
-        namespace TrialSettings {
-          interface EndBehavior {
-            /**
-             * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
-             */
-            prorate_up_front: EndBehavior.ProrateUpFront | null;
-          }
-
-          namespace EndBehavior {
-            type ProrateUpFront = 'defer' | 'include';
-          }
-        }
-      }
-
-      interface Prebilling {
-        /**
-         * ID of the prebilling invoice.
-         */
-        invoice: string | Stripe.Invoice;
-
-        /**
-         * The end of the last period for which the invoice pre-bills.
-         */
-        period_end: number;
-
-        /**
-         * The start of the first period for which the invoice pre-bills.
-         */
-        period_start: number;
-
-        /**
-         * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
-         */
-        update_behavior?: Prebilling.UpdateBehavior;
-      }
-
-      namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
       }
 
       type Status =