stripe 18.6.0-beta.1 → 19.0.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.
        */
@@ -29,7 +34,7 @@ declare module 'stripe' {
       billing_cycle_anchor?: number;
 
       /**
-       * Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
+       * Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC.
        */
       billing_cycle_anchor_config?: SubscriptionCreateParams.BillingCycleAnchorConfig;
 
@@ -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`.
        */
@@ -211,7 +201,7 @@ declare module 'stripe' {
         metadata?: Stripe.MetadataParam;
 
         /**
-         * The period associated with this invoice item. Defaults to the current period of the subscription.
+         * The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
          */
         period?: AddInvoiceItem.Period;
 
@@ -248,56 +238,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 Period {
           /**
            * End of the invoice item period.
@@ -435,12 +381,28 @@ declare module 'stripe' {
 
       interface BillingMode {
         /**
-         * Controls the calculation and orchestration of prorations and invoices for subscriptions.
+         * Configure behavior for flexible billing mode.
+         */
+        flexible?: BillingMode.Flexible;
+
+        /**
+         * Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
          */
         type: BillingMode.Type;
       }
 
       namespace BillingMode {
+        interface Flexible {
+          /**
+           * Controls how invoices and invoice items display proration amounts and discount amounts.
+           */
+          proration_discounts?: Flexible.ProrationDiscounts;
+        }
+
+        namespace Flexible {
+          type ProrationDiscounts = 'included' | 'itemized';
+        }
+
         type Type = 'classic' | 'flexible';
       }
 
@@ -471,56 +433,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.
@@ -591,11 +509,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 {
@@ -617,56 +530,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).
@@ -718,22 +587,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 =
@@ -785,13 +638,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.
            */
@@ -802,11 +648,6 @@ declare module 'stripe' {
            */
           sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
 
-          /**
-           * This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
-           */
-          upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
-
           /**
            * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
            */
@@ -946,47 +787,10 @@ declare module 'stripe' {
             }
           }
 
-          interface IdBankTransfer {}
-
           interface Konbini {}
 
           interface SepaDebit {}
 
-          interface Upi {
-            /**
-             * Configuration options for setting up an eMandate
-             */
-            mandate_options?: Upi.MandateOptions;
-          }
-
-          namespace Upi {
-            interface MandateOptions {
-              /**
-               * Amount to be charged for future payments.
-               */
-              amount?: number;
-
-              /**
-               * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
-               */
-              amount_type?: MandateOptions.AmountType;
-
-              /**
-               * A description of the mandate or subscription that is meant to be displayed to the customer.
-               */
-              description?: string;
-
-              /**
-               * End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
-               */
-              end_date?: number;
-            }
-
-            namespace MandateOptions {
-              type AmountType = 'fixed' | 'maximum';
-            }
-          }
-
           interface UsBankAccount {
             /**
              * Additional fields for Financial Connections Session creation
@@ -1023,11 +827,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 {
@@ -1040,11 +839,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1064,13 +859,11 @@ declare module 'stripe' {
           | 'card'
           | 'cashapp'
           | 'crypto'
-          | 'custom'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
-          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
@@ -1090,9 +883,7 @@ declare module 'stripe' {
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
-          | 'stripe_balance'
           | 'swish'
-          | 'upi'
           | 'us_bank_account'
           | 'wechat_pay';
 
@@ -1115,22 +906,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 {
@@ -1311,11 +1086,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`.
        */
@@ -1360,7 +1130,7 @@ declare module 'stripe' {
         metadata?: Stripe.MetadataParam;
 
         /**
-         * The period associated with this invoice item. Defaults to the current period of the subscription.
+         * The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
          */
         period?: AddInvoiceItem.Period;
 
@@ -1397,56 +1167,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 Period {
           /**
            * End of the invoice item period.
@@ -1608,56 +1334,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.
@@ -1764,56 +1446,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).
@@ -1932,13 +1570,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.
            */
@@ -1949,11 +1580,6 @@ declare module 'stripe' {
            */
           sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
 
-          /**
-           * This sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
-           */
-          upi?: Stripe.Emptyable<PaymentMethodOptions.Upi>;
-
           /**
            * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
            */
@@ -2093,47 +1719,10 @@ declare module 'stripe' {
             }
           }
 
-          interface IdBankTransfer {}
-
           interface Konbini {}
 
           interface SepaDebit {}
 
-          interface Upi {
-            /**
-             * Configuration options for setting up an eMandate
-             */
-            mandate_options?: Upi.MandateOptions;
-          }
-
-          namespace Upi {
-            interface MandateOptions {
-              /**
-               * Amount to be charged for future payments.
-               */
-              amount?: number;
-
-              /**
-               * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
-               */
-              amount_type?: MandateOptions.AmountType;
-
-              /**
-               * A description of the mandate or subscription that is meant to be displayed to the customer.
-               */
-              description?: string;
-
-              /**
-               * End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
-               */
-              end_date?: number;
-            }
-
-            namespace MandateOptions {
-              type AmountType = 'fixed' | 'maximum';
-            }
-          }
-
           interface UsBankAccount {
             /**
              * Additional fields for Financial Connections Session creation
@@ -2170,11 +1759,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 {
@@ -2187,11 +1771,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -2211,13 +1791,11 @@ declare module 'stripe' {
           | 'card'
           | 'cashapp'
           | 'crypto'
-          | 'custom'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
-          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
@@ -2237,9 +1815,7 @@ declare module 'stripe' {
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
-          | 'stripe_balance'
           | 'swish'
-          | 'upi'
           | 'us_bank_account'
           | 'wechat_pay';
 
@@ -2262,22 +1838,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 {
@@ -2344,11 +1904,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.
        */
@@ -2462,8 +2017,29 @@ declare module 'stripe' {
 
     namespace SubscriptionMigrateParams {
       interface BillingMode {
+        /**
+         * Configure behavior for flexible billing mode.
+         */
+        flexible?: BillingMode.Flexible;
+
+        /**
+         * Controls the calculation and orchestration of prorations and invoices for subscriptions.
+         */
         type: 'flexible';
       }
+
+      namespace BillingMode {
+        interface Flexible {
+          /**
+           * Controls how invoices and invoice items display proration amounts and discount amounts.
+           */
+          proration_discounts?: Flexible.ProrationDiscounts;
+        }
+
+        namespace Flexible {
+          type ProrationDiscounts = 'included' | 'itemized';
+        }
+      }
     }
 
     interface SubscriptionResumeParams {
@@ -2527,10 +2103,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>>;