stripe 17.8.0-beta.1 → 18.0.0

package/types/SubscriptionsResource.d.ts

@@ -38,13 +38,6 @@ declare module 'stripe' {
        */
       billing_cycle_anchor_config?: SubscriptionCreateParams.BillingCycleAnchorConfig;
 
-      /**
-       * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
-       */
-      billing_thresholds?: Stripe.Emptyable<
-        SubscriptionCreateParams.BillingThresholds
-      >;
-
       /**
        * 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.
        */
@@ -60,11 +53,6 @@ declare module 'stripe' {
        */
       collection_method?: SubscriptionCreateParams.CollectionMethod;
 
-      /**
-       * The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
-       */
-      coupon?: string;
-
       /**
        * 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).
        */
@@ -157,16 +145,6 @@ declare module 'stripe' {
         SubscriptionCreateParams.PendingInvoiceItemInterval
       >;
 
-      /**
-       * If specified, the invoicing for the given billing cycle iterations will be processed now.
-       */
-      prebilling?: SubscriptionCreateParams.Prebilling;
-
-      /**
-       * The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
-       */
-      promotion_code?: string;
-
       /**
        * 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 +216,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).
@@ -295,7 +229,7 @@ declare module 'stripe' {
           currency: string;
 
           /**
-           * The ID of the product that this price will belong to.
+           * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
            */
           product: string;
 
@@ -377,18 +311,6 @@ declare module 'stripe' {
         second?: number;
       }
 
-      interface BillingThresholds {
-        /**
-         * Monetary threshold that triggers the subscription to advance to a new billing period
-         */
-        amount_gte?: number;
-
-        /**
-         * 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.
-         */
-        reset_billing_cycle_anchor?: boolean;
-      }
-
       type CollectionMethod = 'charge_automatically' | 'send_invoice';
 
       interface Discount {
@@ -402,56 +324,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.
@@ -483,11 +361,6 @@ declare module 'stripe' {
       }
 
       interface Item {
-        /**
-         * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
-         */
-        billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
-
         /**
          * The coupons to redeem into discounts for the subscription item.
          */
@@ -522,21 +395,9 @@ 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 {
-        interface BillingThresholds {
-          /**
-           * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
-           */
-          usage_gte: number;
-        }
-
         interface Discount {
           /**
            * ID of the coupon to create a new discount for.
@@ -548,56 +409,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).
@@ -605,7 +422,7 @@ declare module 'stripe' {
           currency: string;
 
           /**
-           * The ID of the product that this price will belong to.
+           * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
            */
           product: string;
 
@@ -649,22 +466,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 =
@@ -716,13 +517,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.
            */
@@ -872,8 +666,6 @@ declare module 'stripe' {
             }
           }
 
-          interface IdBankTransfer {}
-
           interface Konbini {}
 
           interface SepaDebit {}
@@ -914,11 +706,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 {
@@ -931,11 +718,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -953,21 +736,21 @@ declare module 'stripe' {
           | 'boleto'
           | 'card'
           | 'cashapp'
-          | 'custom'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
-          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
+          | 'klarna'
           | 'konbini'
           | 'kr_card'
           | 'link'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'p24'
           | 'payco'
           | 'paynow'
@@ -1000,22 +783,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 {
@@ -1079,13 +846,6 @@ declare module 'stripe' {
        */
       billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;
 
-      /**
-       * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
-       */
-      billing_thresholds?: Stripe.Emptyable<
-        SubscriptionUpdateParams.BillingThresholds
-      >;
-
       /**
        * 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.
        */
@@ -1106,11 +866,6 @@ declare module 'stripe' {
        */
       collection_method?: SubscriptionUpdateParams.CollectionMethod;
 
-      /**
-       * The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
-       */
-      coupon?: 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`.
        */
@@ -1201,16 +956,6 @@ declare module 'stripe' {
         SubscriptionUpdateParams.PendingInvoiceItemInterval
       >;
 
-      /**
-       * If specified, the invoicing for the given billing cycle iterations will be processed now.
-       */
-      prebilling?: SubscriptionUpdateParams.Prebilling;
-
-      /**
-       * The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
-       */
-      promotion_code?: string;
-
       /**
        * 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`.
        */
@@ -1282,56 +1027,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).
@@ -1339,7 +1040,7 @@ declare module 'stripe' {
           currency: string;
 
           /**
-           * The ID of the product that this price will belong to.
+           * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
            */
           product: string;
 
@@ -1396,18 +1097,6 @@ declare module 'stripe' {
 
       type BillingCycleAnchor = 'now' | 'unchanged';
 
-      interface BillingThresholds {
-        /**
-         * Monetary threshold that triggers the subscription to advance to a new billing period
-         */
-        amount_gte?: number;
-
-        /**
-         * 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.
-         */
-        reset_billing_cycle_anchor?: boolean;
-      }
-
       interface CancellationDetails {
         /**
          * Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
@@ -1445,56 +1134,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.
@@ -1526,11 +1171,6 @@ declare module 'stripe' {
       }
 
       interface Item {
-        /**
-         * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
-         */
-        billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
-
         /**
          * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
          */
@@ -1583,13 +1223,6 @@ declare module 'stripe' {
       }
 
       namespace Item {
-        interface BillingThresholds {
-          /**
-           * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
-           */
-          usage_gte: number;
-        }
-
         interface Discount {
           /**
            * ID of the coupon to create a new discount for.
@@ -1601,56 +1234,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).
@@ -1658,7 +1247,7 @@ declare module 'stripe' {
           currency: string;
 
           /**
-           * The ID of the product that this price will belong to.
+           * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
            */
           product: string;
 
@@ -1769,13 +1358,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 +1507,6 @@ declare module 'stripe' {
             }
           }
 
-          interface IdBankTransfer {}
-
           interface Konbini {}
 
           interface SepaDebit {}
@@ -1967,11 +1547,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 +1559,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -2006,21 +1577,21 @@ declare module 'stripe' {
           | 'boleto'
           | 'card'
           | 'cashapp'
-          | 'custom'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
-          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
+          | 'klarna'
           | 'konbini'
           | 'kr_card'
           | 'link'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'p24'
           | 'payco'
           | 'paynow'
@@ -2053,22 +1624,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 {