stripe 17.7.0 → 18.0.0

package/types/SubscriptionSchedulesResource.d.ts

@@ -61,13 +61,6 @@ 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. Pass an empty string to remove previously-defined thresholds.
-         */
-        billing_thresholds?: Stripe.Emptyable<
-          DefaultSettings.BillingThresholds
-        >;
-
         /**
          * 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`. Defaults to `charge_automatically` on creation.
          */
@@ -132,18 +125,6 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'automatic' | 'phase_start';
 
-        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 InvoiceSettings {
@@ -217,21 +198,11 @@ declare module 'stripe' {
          */
         billing_cycle_anchor?: Phase.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<Phase.BillingThresholds>;
-
         /**
          * 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`. Defaults to `charge_automatically` on creation.
          */
         collection_method?: Phase.CollectionMethod;
 
-        /**
-         * The ID of the coupon to apply to this phase of the subscription schedule. 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).
          */
@@ -361,7 +332,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;
 
@@ -418,18 +389,6 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'automatic' | 'phase_start';
 
-        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 {
@@ -485,11 +444,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.
            */
@@ -527,13 +481,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.
@@ -558,7 +505,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;
 
@@ -679,13 +626,6 @@ 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. Pass an empty string to remove previously-defined thresholds.
-         */
-        billing_thresholds?: Stripe.Emptyable<
-          DefaultSettings.BillingThresholds
-        >;
-
         /**
          * 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`. Defaults to `charge_automatically` on creation.
          */
@@ -750,18 +690,6 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'automatic' | 'phase_start';
 
-        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 InvoiceSettings {
@@ -835,21 +763,11 @@ declare module 'stripe' {
          */
         billing_cycle_anchor?: Phase.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<Phase.BillingThresholds>;
-
         /**
          * 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`. Defaults to `charge_automatically` on creation.
          */
         collection_method?: Phase.CollectionMethod;
 
-        /**
-         * The ID of the coupon to apply to this phase of the subscription schedule. 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).
          */
@@ -984,7 +902,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;
 
@@ -1041,18 +959,6 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'automatic' | 'phase_start';
 
-        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 {
@@ -1108,11 +1014,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.
            */
@@ -1150,13 +1051,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.
@@ -1181,7 +1075,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;
 

package/types/Subscriptions.d.ts

@@ -44,11 +44,6 @@ declare module 'stripe' {
        */
       billing_cycle_anchor_config: Subscription.BillingCycleAnchorConfig | null;
 
-      /**
-       * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
-       */
-      billing_thresholds: Subscription.BillingThresholds | null;
-
       /**
        * A date in the future at which the subscription will automatically get canceled
        */
@@ -84,16 +79,6 @@ declare module 'stripe' {
        */
       currency: string;
 
-      /**
-       * End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
-       */
-      current_period_end: number;
-
-      /**
-       * Start of the current period that the subscription has been invoiced for.
-       */
-      current_period_start: number;
-
       /**
        * ID of the customer who owns the subscription.
        */
@@ -124,11 +109,6 @@ declare module 'stripe' {
        */
       description: string | null;
 
-      /**
-       * Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
-       */
-      discount: Stripe.Discount | null;
-
       /**
        * The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
        */
@@ -167,7 +147,7 @@ declare module 'stripe' {
       next_pending_invoice_item_invoice: number | null;
 
       /**
-       * The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.
+       * The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://stripe.com/docs/connect/subscriptions#on-behalf-of) for details.
        */
       on_behalf_of: string | Stripe.Account | null;
 
@@ -310,18 +290,6 @@ declare module 'stripe' {
         second: number | null;
       }
 
-      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;
-      }
-
       interface CancellationDetails {
         /**
          * Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
@@ -653,11 +621,13 @@ declare module 'stripe' {
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
+          | 'klarna'
           | 'konbini'
           | 'kr_card'
           | 'link'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'p24'
           | 'payco'
           | 'paynow'

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,11 +145,6 @@ declare module 'stripe' {
         SubscriptionCreateParams.PendingInvoiceItemInterval
       >;
 
-      /**
-       * 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`.
        */
@@ -246,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;
 
@@ -328,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 {
@@ -390,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.
          */
@@ -432,13 +398,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.
@@ -463,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;
 
@@ -785,11 +744,13 @@ declare module 'stripe' {
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
+          | 'klarna'
           | 'konbini'
           | 'kr_card'
           | 'link'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'p24'
           | 'payco'
           | 'paynow'
@@ -885,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.
        */
@@ -912,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`.
        */
@@ -1007,11 +956,6 @@ declare module 'stripe' {
         SubscriptionUpdateParams.PendingInvoiceItemInterval
       >;
 
-      /**
-       * 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`.
        */
@@ -1096,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;
 
@@ -1153,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.
@@ -1239,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.
          */
@@ -1296,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.
@@ -1327,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;
 
@@ -1665,11 +1585,13 @@ declare module 'stripe' {
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
+          | 'klarna'
           | 'konbini'
           | 'kr_card'
           | 'link'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'p24'
           | 'payco'
           | 'paynow'

package/types/Tax/Calculations.d.ts

@@ -446,7 +446,7 @@ declare module 'stripe' {
             percentage_decimal: string;
 
             /**
-             * Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.
+             * Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
              */
             rate_type: TaxRateDetails.RateType | null;
 

package/types/Tax/RegistrationsResource.d.ts

@@ -1603,7 +1603,7 @@ declare module 'stripe' {
           namespace Us {
             interface LocalAmusementTax {
               /**
-               * A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), and `68081` (Schiller Park).
+               * A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `64343` (River Grove), and `68081` (Schiller Park).
                */
               jurisdiction: string;
             }

package/types/TaxRates.d.ts

@@ -86,7 +86,7 @@ declare module 'stripe' {
       percentage: number;
 
       /**
-       * Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.
+       * Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
        */
       rate_type: TaxRate.RateType | null;