stripe 18.3.0-beta.1 → 18.3.0

package/types/SubscriptionsResource.d.ts

@@ -3,6 +3,11 @@
 declare module 'stripe' {
   namespace Stripe {
     interface SubscriptionCreateParams {
+      /**
+       * The identifier of the customer to subscribe.
+       */
+      customer: string;
+
       /**
        * A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
        */
@@ -14,12 +19,12 @@ declare module 'stripe' {
       application_fee_percent?: Stripe.Emptyable<number>;
 
       /**
-       * Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
+       * Automatic tax settings for this subscription.
        */
       automatic_tax?: SubscriptionCreateParams.AutomaticTax;
 
       /**
-       * For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
+       * A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
        */
       backdate_start_date?: number;
 
@@ -48,10 +53,10 @@ declare module 'stripe' {
       /**
        * A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
        */
-      cancel_at?: number | SubscriptionCreateParams.CancelAt;
+      cancel_at?: number;
 
       /**
-       * Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
+       * Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
        */
       cancel_at_period_end?: boolean;
 
@@ -65,16 +70,6 @@ declare module 'stripe' {
        */
       currency?: string;
 
-      /**
-       * The identifier of the customer to subscribe.
-       */
-      customer?: string;
-
-      /**
-       * The identifier of the account to subscribe.
-       */
-      customer_account?: string;
-
       /**
        * Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
        */
@@ -162,11 +157,6 @@ declare module 'stripe' {
         SubscriptionCreateParams.PendingInvoiceItemInterval
       >;
 
-      /**
-       * If specified, the invoicing for the given billing cycle iterations will be processed now.
-       */
-      prebilling?: SubscriptionCreateParams.Prebilling;
-
       /**
        * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
        */
@@ -238,56 +228,12 @@ declare module 'stripe' {
            */
           discount?: string;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code?: string;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * Time span for the redeemed discount.
-             */
-            duration?: DiscountEnd.Duration;
-
-            /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
-             */
-            timestamp?: number;
-
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
-          }
-
-          namespace DiscountEnd {
-            interface Duration {
-              /**
-               * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Duration.Interval;
-
-              /**
-               * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-               */
-              interval_count: number;
-            }
-
-            namespace Duration {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type Type = 'duration' | 'timestamp';
-          }
-        }
-
         interface PriceData {
           /**
            * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -377,7 +323,13 @@ declare module 'stripe' {
         second?: number;
       }
 
-      type BillingMode = 'classic' | 'flexible';
+      interface BillingMode {
+        type: BillingMode.Type;
+      }
+
+      namespace BillingMode {
+        type Type = 'classic' | 'flexible';
+      }
 
       interface BillingThresholds {
         /**
@@ -391,8 +343,6 @@ declare module 'stripe' {
         reset_billing_cycle_anchor?: boolean;
       }
 
-      type CancelAt = 'max_period_end' | 'min_period_end';
-
       type CollectionMethod = 'charge_automatically' | 'send_invoice';
 
       interface Discount {
@@ -406,56 +356,12 @@ declare module 'stripe' {
          */
         discount?: string;
 
-        /**
-         * Details to determine how long the discount should be applied for.
-         */
-        discount_end?: Discount.DiscountEnd;
-
         /**
          * ID of the promotion code to create a new discount for.
          */
         promotion_code?: string;
       }
 
-      namespace Discount {
-        interface DiscountEnd {
-          /**
-           * Time span for the redeemed discount.
-           */
-          duration?: DiscountEnd.Duration;
-
-          /**
-           * A precise Unix timestamp for the discount to end. Must be in the future.
-           */
-          timestamp?: number;
-
-          /**
-           * The type of calculation made to determine when the discount ends.
-           */
-          type: DiscountEnd.Type;
-        }
-
-        namespace DiscountEnd {
-          interface Duration {
-            /**
-             * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-             */
-            interval: Duration.Interval;
-
-            /**
-             * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-             */
-            interval_count: number;
-          }
-
-          namespace Duration {
-            type Interval = 'day' | 'month' | 'week' | 'year';
-          }
-
-          type Type = 'duration' | 'timestamp';
-        }
-      }
-
       interface InvoiceSettings {
         /**
          * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -526,11 +432,6 @@ declare module 'stripe' {
          * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
          */
         tax_rates?: Stripe.Emptyable<Array<string>>;
-
-        /**
-         * Define options to configure the trial on the subscription item.
-         */
-        trial?: Item.Trial;
       }
 
       namespace Item {
@@ -552,56 +453,12 @@ declare module 'stripe' {
            */
           discount?: string;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code?: string;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * Time span for the redeemed discount.
-             */
-            duration?: DiscountEnd.Duration;
-
-            /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
-             */
-            timestamp?: number;
-
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
-          }
-
-          namespace DiscountEnd {
-            interface Duration {
-              /**
-               * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Duration.Interval;
-
-              /**
-               * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-               */
-              interval_count: number;
-            }
-
-            namespace Duration {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type Type = 'duration' | 'timestamp';
-          }
-        }
-
         interface PriceData {
           /**
            * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -653,22 +510,6 @@ declare module 'stripe' {
 
           type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
         }
-
-        interface Trial {
-          /**
-           * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
-           */
-          converts_to?: Array<string>;
-
-          /**
-           * Determines the type of trial for this item.
-           */
-          type: Trial.Type;
-        }
-
-        namespace Trial {
-          type Type = 'free' | 'paid';
-        }
       }
 
       type PaymentBehavior =
@@ -720,13 +561,6 @@ declare module 'stripe' {
             PaymentMethodOptions.CustomerBalance
           >;
 
-          /**
-           * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
-           */
-          id_bank_transfer?: Stripe.Emptyable<
-            PaymentMethodOptions.IdBankTransfer
-          >;
-
           /**
            * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
            */
@@ -876,8 +710,6 @@ declare module 'stripe' {
             }
           }
 
-          interface IdBankTransfer {}
-
           interface Konbini {}
 
           interface SepaDebit {}
@@ -918,11 +750,6 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
-
-                /**
-                 * ID of the institution to use to filter for selectable accounts.
-                 */
-                institution?: string;
               }
 
               namespace Filters {
@@ -935,11 +762,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -958,13 +781,12 @@ declare module 'stripe' {
           | 'boleto'
           | 'card'
           | 'cashapp'
-          | 'custom'
+          | 'crypto'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
-          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
@@ -984,7 +806,6 @@ declare module 'stripe' {
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
-          | 'stripe_balance'
           | 'swish'
           | 'us_bank_account'
           | 'wechat_pay';
@@ -1008,22 +829,6 @@ declare module 'stripe' {
         type Interval = 'day' | 'month' | 'week' | 'year';
       }
 
-      interface Prebilling {
-        /**
-         * This is used to determine the number of billing cycles to prebill.
-         */
-        iterations: number;
-
-        /**
-         * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
-         */
-        update_behavior?: Prebilling.UpdateBehavior;
-      }
-
-      namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
-      }
-
       type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
 
       interface TransferData {
@@ -1097,10 +902,10 @@ declare module 'stripe' {
       /**
        * A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
        */
-      cancel_at?: Stripe.Emptyable<number | SubscriptionUpdateParams.CancelAt>;
+      cancel_at?: Stripe.Emptyable<number>;
 
       /**
-       * Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
+       * Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
        */
       cancel_at_period_end?: boolean;
 
@@ -1204,11 +1009,6 @@ declare module 'stripe' {
         SubscriptionUpdateParams.PendingInvoiceItemInterval
       >;
 
-      /**
-       * If specified, the invoicing for the given billing cycle iterations will be processed now.
-       */
-      prebilling?: SubscriptionUpdateParams.Prebilling;
-
       /**
        * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
        */
@@ -1280,56 +1080,12 @@ declare module 'stripe' {
            */
           discount?: string;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code?: string;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * Time span for the redeemed discount.
-             */
-            duration?: DiscountEnd.Duration;
-
-            /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
-             */
-            timestamp?: number;
-
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
-          }
-
-          namespace DiscountEnd {
-            interface Duration {
-              /**
-               * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Duration.Interval;
-
-              /**
-               * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-               */
-              interval_count: number;
-            }
-
-            namespace Duration {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type Type = 'duration' | 'timestamp';
-          }
-        }
-
         interface PriceData {
           /**
            * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -1406,8 +1162,6 @@ declare module 'stripe' {
         reset_billing_cycle_anchor?: boolean;
       }
 
-      type CancelAt = 'max_period_end' | 'min_period_end';
-
       interface CancellationDetails {
         /**
          * Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
@@ -1445,56 +1199,12 @@ declare module 'stripe' {
          */
         discount?: string;
 
-        /**
-         * Details to determine how long the discount should be applied for.
-         */
-        discount_end?: Discount.DiscountEnd;
-
         /**
          * ID of the promotion code to create a new discount for.
          */
         promotion_code?: string;
       }
 
-      namespace Discount {
-        interface DiscountEnd {
-          /**
-           * Time span for the redeemed discount.
-           */
-          duration?: DiscountEnd.Duration;
-
-          /**
-           * A precise Unix timestamp for the discount to end. Must be in the future.
-           */
-          timestamp?: number;
-
-          /**
-           * The type of calculation made to determine when the discount ends.
-           */
-          type: DiscountEnd.Type;
-        }
-
-        namespace DiscountEnd {
-          interface Duration {
-            /**
-             * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-             */
-            interval: Duration.Interval;
-
-            /**
-             * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-             */
-            interval_count: number;
-          }
-
-          namespace Duration {
-            type Interval = 'day' | 'month' | 'week' | 'year';
-          }
-
-          type Type = 'duration' | 'timestamp';
-        }
-      }
-
       interface InvoiceSettings {
         /**
          * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -1601,56 +1311,12 @@ declare module 'stripe' {
            */
           discount?: string;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code?: string;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * Time span for the redeemed discount.
-             */
-            duration?: DiscountEnd.Duration;
-
-            /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
-             */
-            timestamp?: number;
-
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
-          }
-
-          namespace DiscountEnd {
-            interface Duration {
-              /**
-               * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Duration.Interval;
-
-              /**
-               * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-               */
-              interval_count: number;
-            }
-
-            namespace Duration {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type Type = 'duration' | 'timestamp';
-          }
-        }
-
         interface PriceData {
           /**
            * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
@@ -1769,13 +1435,6 @@ declare module 'stripe' {
             PaymentMethodOptions.CustomerBalance
           >;
 
-          /**
-           * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
-           */
-          id_bank_transfer?: Stripe.Emptyable<
-            PaymentMethodOptions.IdBankTransfer
-          >;
-
           /**
            * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
            */
@@ -1925,8 +1584,6 @@ declare module 'stripe' {
             }
           }
 
-          interface IdBankTransfer {}
-
           interface Konbini {}
 
           interface SepaDebit {}
@@ -1967,11 +1624,6 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
-
-                /**
-                 * ID of the institution to use to filter for selectable accounts.
-                 */
-                institution?: string;
               }
 
               namespace Filters {
@@ -1984,11 +1636,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -2007,13 +1655,12 @@ declare module 'stripe' {
           | 'boleto'
           | 'card'
           | 'cashapp'
-          | 'custom'
+          | 'crypto'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
-          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
@@ -2033,7 +1680,6 @@ declare module 'stripe' {
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
-          | 'stripe_balance'
           | 'swish'
           | 'us_bank_account'
           | 'wechat_pay';
@@ -2057,22 +1703,6 @@ declare module 'stripe' {
         type Interval = 'day' | 'month' | 'week' | 'year';
       }
 
-      interface Prebilling {
-        /**
-         * This is used to determine the number of billing cycles to prebill.
-         */
-        iterations: number;
-
-        /**
-         * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
-         */
-        update_behavior?: Prebilling.UpdateBehavior;
-      }
-
-      namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
-      }
-
       type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
 
       interface TransferData {
@@ -2139,11 +1769,6 @@ declare module 'stripe' {
        */
       customer?: string;
 
-      /**
-       * The ID of the account whose subscriptions will be retrieved.
-       */
-      customer_account?: string;
-
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -2247,7 +1872,7 @@ declare module 'stripe' {
       /**
        * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
        */
-      billing_mode: 'flexible';
+      billing_mode: SubscriptionMigrateParams.BillingMode;
 
       /**
        * Specifies which fields in the response should be expanded.
@@ -2255,6 +1880,12 @@ declare module 'stripe' {
       expand?: Array<string>;
     }
 
+    namespace SubscriptionMigrateParams {
+      interface BillingMode {
+        type: 'flexible';
+      }
+    }
+
     interface SubscriptionResumeParams {
       /**
        * The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
@@ -2316,10 +1947,7 @@ declare module 'stripe' {
        * Schedules provide the flexibility to model more complex billing configurations that change over time.
        */
       create(
-        params?: SubscriptionCreateParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.Subscription>>;
-      create(
+        params: SubscriptionCreateParams,
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.Subscription>>;