stripe 17.7.0 → 18.0.0

package/types/SetupIntentsResource.d.ts

@@ -99,6 +99,8 @@ declare module 'stripe' {
 
       /**
        * If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.
+       *
+       * Single-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`.
        */
       single_use?: SetupIntentCreateParams.SingleUse;
 
@@ -234,6 +236,11 @@ declare module 'stripe' {
          */
         bancontact?: PaymentMethodData.Bancontact;
 
+        /**
+         * If this is a `billie` PaymentMethod, this hash contains details about the billie payment method.
+         */
+        billie?: PaymentMethodData.Billie;
+
         /**
          * Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
          */
@@ -334,6 +341,11 @@ declare module 'stripe' {
          */
         naver_pay?: PaymentMethodData.NaverPay;
 
+        /**
+         * If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
+         */
+        nz_bank_account?: PaymentMethodData.NzBankAccount;
+
         /**
          * If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
          */
@@ -389,6 +401,11 @@ declare module 'stripe' {
          */
         samsung_pay?: PaymentMethodData.SamsungPay;
 
+        /**
+         * If this is a `satispay` PaymentMethod, this hash contains details about the satispay payment method.
+         */
+        satispay?: PaymentMethodData.Satispay;
+
         /**
          * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
          */
@@ -486,6 +503,8 @@ declare module 'stripe' {
 
         interface Bancontact {}
 
+        interface Billie {}
+
         interface BillingDetails {
           /**
            * Billing address.
@@ -682,6 +701,35 @@ declare module 'stripe' {
           type Funding = 'card' | 'points';
         }
 
+        interface NzBankAccount {
+          /**
+           * The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
+           */
+          account_holder_name?: string;
+
+          /**
+           * The account number for the bank account.
+           */
+          account_number: string;
+
+          /**
+           * The numeric code for the bank account's bank.
+           */
+          bank_code: string;
+
+          /**
+           * The numeric code for the bank account's bank branch.
+           */
+          branch_code: string;
+
+          reference?: string;
+
+          /**
+           * The suffix of the bank account number.
+           */
+          suffix: string;
+        }
+
         interface Oxxo {}
 
         interface P24 {
@@ -744,6 +792,8 @@ declare module 'stripe' {
 
         interface SamsungPay {}
 
+        interface Satispay {}
+
         interface SepaDebit {
           /**
            * IBAN of the bank account.
@@ -776,6 +826,7 @@ declare module 'stripe' {
           | 'au_becs_debit'
           | 'bacs_debit'
           | 'bancontact'
+          | 'billie'
           | 'blik'
           | 'boleto'
           | 'cashapp'
@@ -793,6 +844,7 @@ declare module 'stripe' {
           | 'mobilepay'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'oxxo'
           | 'p24'
           | 'pay_by_bank'
@@ -803,6 +855,7 @@ declare module 'stripe' {
           | 'promptpay'
           | 'revolut_pay'
           | 'samsung_pay'
+          | 'satispay'
           | 'sepa_debit'
           | 'sofort'
           | 'swish'
@@ -1437,6 +1490,11 @@ declare module 'stripe' {
          */
         bancontact?: PaymentMethodData.Bancontact;
 
+        /**
+         * If this is a `billie` PaymentMethod, this hash contains details about the billie payment method.
+         */
+        billie?: PaymentMethodData.Billie;
+
         /**
          * Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
          */
@@ -1537,6 +1595,11 @@ declare module 'stripe' {
          */
         naver_pay?: PaymentMethodData.NaverPay;
 
+        /**
+         * If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
+         */
+        nz_bank_account?: PaymentMethodData.NzBankAccount;
+
         /**
          * If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
          */
@@ -1592,6 +1655,11 @@ declare module 'stripe' {
          */
         samsung_pay?: PaymentMethodData.SamsungPay;
 
+        /**
+         * If this is a `satispay` PaymentMethod, this hash contains details about the satispay payment method.
+         */
+        satispay?: PaymentMethodData.Satispay;
+
         /**
          * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
          */
@@ -1689,6 +1757,8 @@ declare module 'stripe' {
 
         interface Bancontact {}
 
+        interface Billie {}
+
         interface BillingDetails {
           /**
            * Billing address.
@@ -1885,6 +1955,35 @@ declare module 'stripe' {
           type Funding = 'card' | 'points';
         }
 
+        interface NzBankAccount {
+          /**
+           * The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
+           */
+          account_holder_name?: string;
+
+          /**
+           * The account number for the bank account.
+           */
+          account_number: string;
+
+          /**
+           * The numeric code for the bank account's bank.
+           */
+          bank_code: string;
+
+          /**
+           * The numeric code for the bank account's bank branch.
+           */
+          branch_code: string;
+
+          reference?: string;
+
+          /**
+           * The suffix of the bank account number.
+           */
+          suffix: string;
+        }
+
         interface Oxxo {}
 
         interface P24 {
@@ -1947,6 +2046,8 @@ declare module 'stripe' {
 
         interface SamsungPay {}
 
+        interface Satispay {}
+
         interface SepaDebit {
           /**
            * IBAN of the bank account.
@@ -1979,6 +2080,7 @@ declare module 'stripe' {
           | 'au_becs_debit'
           | 'bacs_debit'
           | 'bancontact'
+          | 'billie'
           | 'blik'
           | 'boleto'
           | 'cashapp'
@@ -1996,6 +2098,7 @@ declare module 'stripe' {
           | 'mobilepay'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'oxxo'
           | 'p24'
           | 'pay_by_bank'
@@ -2006,6 +2109,7 @@ declare module 'stripe' {
           | 'promptpay'
           | 'revolut_pay'
           | 'samsung_pay'
+          | 'satispay'
           | 'sepa_debit'
           | 'sofort'
           | 'swish'
@@ -2689,6 +2793,11 @@ declare module 'stripe' {
          */
         bancontact?: PaymentMethodData.Bancontact;
 
+        /**
+         * If this is a `billie` PaymentMethod, this hash contains details about the billie payment method.
+         */
+        billie?: PaymentMethodData.Billie;
+
         /**
          * Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
          */
@@ -2789,6 +2898,11 @@ declare module 'stripe' {
          */
         naver_pay?: PaymentMethodData.NaverPay;
 
+        /**
+         * If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
+         */
+        nz_bank_account?: PaymentMethodData.NzBankAccount;
+
         /**
          * If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
          */
@@ -2844,6 +2958,11 @@ declare module 'stripe' {
          */
         samsung_pay?: PaymentMethodData.SamsungPay;
 
+        /**
+         * If this is a `satispay` PaymentMethod, this hash contains details about the satispay payment method.
+         */
+        satispay?: PaymentMethodData.Satispay;
+
         /**
          * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
          */
@@ -2941,6 +3060,8 @@ declare module 'stripe' {
 
         interface Bancontact {}
 
+        interface Billie {}
+
         interface BillingDetails {
           /**
            * Billing address.
@@ -3137,6 +3258,35 @@ declare module 'stripe' {
           type Funding = 'card' | 'points';
         }
 
+        interface NzBankAccount {
+          /**
+           * The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
+           */
+          account_holder_name?: string;
+
+          /**
+           * The account number for the bank account.
+           */
+          account_number: string;
+
+          /**
+           * The numeric code for the bank account's bank.
+           */
+          bank_code: string;
+
+          /**
+           * The numeric code for the bank account's bank branch.
+           */
+          branch_code: string;
+
+          reference?: string;
+
+          /**
+           * The suffix of the bank account number.
+           */
+          suffix: string;
+        }
+
         interface Oxxo {}
 
         interface P24 {
@@ -3199,6 +3349,8 @@ declare module 'stripe' {
 
         interface SamsungPay {}
 
+        interface Satispay {}
+
         interface SepaDebit {
           /**
            * IBAN of the bank account.
@@ -3231,6 +3383,7 @@ declare module 'stripe' {
           | 'au_becs_debit'
           | 'bacs_debit'
           | 'bancontact'
+          | 'billie'
           | 'blik'
           | 'boleto'
           | 'cashapp'
@@ -3248,6 +3401,7 @@ declare module 'stripe' {
           | 'mobilepay'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'oxxo'
           | 'p24'
           | 'pay_by_bank'
@@ -3258,6 +3412,7 @@ declare module 'stripe' {
           | 'promptpay'
           | 'revolut_pay'
           | 'samsung_pay'
+          | 'satispay'
           | 'sepa_debit'
           | 'sofort'
           | 'swish'

package/types/SubscriptionItems.d.ts

@@ -38,14 +38,19 @@ declare module 'stripe' {
       object: 'subscription_item';
 
       /**
-       * Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
        */
-      billing_thresholds: SubscriptionItem.BillingThresholds | null;
+      created: number;
 
       /**
-       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       * The end time of this subscription item's current billing period.
        */
-      created: number;
+      current_period_end: number;
+
+      /**
+       * The start time of this subscription item's current billing period.
+       */
+      current_period_start: number;
 
       /**
        * Always true for a deleted object
@@ -99,14 +104,5 @@ declare module 'stripe' {
        */
       tax_rates: Array<Stripe.TaxRate> | null;
     }
-
-    namespace SubscriptionItem {
-      interface BillingThresholds {
-        /**
-         * Usage threshold that triggers the subscription to create an invoice
-         */
-        usage_gte: number | null;
-      }
-    }
   }
 }

package/types/SubscriptionItemsResource.d.ts

@@ -8,13 +8,6 @@ declare module 'stripe' {
        */
       subscription: string;
 
-      /**
-       * 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<
-        SubscriptionItemCreateParams.BillingThresholds
-      >;
-
       /**
        * The coupons to redeem into discounts for the subscription item.
        */
@@ -80,13 +73,6 @@ declare module 'stripe' {
     }
 
     namespace SubscriptionItemCreateParams {
-      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.
@@ -117,7 +103,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;
 
@@ -173,13 +159,6 @@ declare module 'stripe' {
     }
 
     interface SubscriptionItemUpdateParams {
-      /**
-       * 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<
-        SubscriptionItemUpdateParams.BillingThresholds
-      >;
-
       /**
        * The coupons to redeem into discounts for the subscription item.
        */
@@ -250,13 +229,6 @@ declare module 'stripe' {
     }
 
     namespace SubscriptionItemUpdateParams {
-      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.
@@ -287,7 +259,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;
 
@@ -368,40 +340,6 @@ declare module 'stripe' {
       type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
     }
 
-    interface SubscriptionItemCreateUsageRecordParams {
-      /**
-       * The usage quantity for the specified timestamp.
-       */
-      quantity: number;
-
-      /**
-       * Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value.
-       */
-      action?: SubscriptionItemCreateUsageRecordParams.Action;
-
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-
-      /**
-       * The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided.
-       */
-      timestamp?: 'now' | number;
-    }
-
-    namespace SubscriptionItemCreateUsageRecordParams {
-      type Action = 'increment' | 'set';
-    }
-
-    interface SubscriptionItemListUsageRecordSummariesParams
-      extends PaginationParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
     class SubscriptionItemsResource {
       /**
        * Adds a new item to an existing subscription. No existing items will be changed or replaced.
@@ -453,36 +391,6 @@ declare module 'stripe' {
         id: string,
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.DeletedSubscriptionItem>>;
-
-      /**
-       * Creates a usage record for a specified subscription item and date, and fills it with a quantity.
-       *
-       * Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the [metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) plan, Stripe helps you send accurate invoices to your customers.
-       *
-       * The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan's aggregate_usage [parameter](https://stripe.com/docs/api/plans/create#create_plan-aggregate_usage). When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.
-       *
-       * The default pricing model for metered billing is [per-unit pricing. For finer granularity, you can configure metered billing to have a <a href="https://stripe.com/docs/billing/subscriptions/tiers">tiered pricing](https://stripe.com/docs/api/plans/object#plan_object-billing_scheme) model.
-       */
-      createUsageRecord(
-        id: string,
-        params: SubscriptionItemCreateUsageRecordParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.UsageRecord>>;
-
-      /**
-       * For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that's been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).
-       *
-       * The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn't ended yet. Since new usage records can still be added, the returned summary information for the subscription item's ID should be seen as unstable until the subscription billing period ends.
-       */
-      listUsageRecordSummaries(
-        id: string,
-        params?: SubscriptionItemListUsageRecordSummariesParams,
-        options?: RequestOptions
-      ): ApiListPromise<Stripe.UsageRecordSummary>;
-      listUsageRecordSummaries(
-        id: string,
-        options?: RequestOptions
-      ): ApiListPromise<Stripe.UsageRecordSummary>;
     }
   }
 }

package/types/SubscriptionSchedules.d.ts

@@ -126,11 +126,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
-         */
-        billing_thresholds: DefaultSettings.BillingThresholds | null;
-
         /**
          * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
          */
@@ -197,18 +192,6 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'automatic' | 'phase_start';
 
-        interface BillingThresholds {
-          /**
-           * Monetary threshold that triggers the subscription to create an invoice
-           */
-          amount_gte: number | null;
-
-          /**
-           * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
-           */
-          reset_billing_cycle_anchor: boolean | null;
-        }
-
         type CollectionMethod = 'charge_automatically' | 'send_invoice';
 
         interface InvoiceSettings {
@@ -278,21 +261,11 @@ declare module 'stripe' {
          */
         billing_cycle_anchor: Phase.BillingCycleAnchor | null;
 
-        /**
-         * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
-         */
-        billing_thresholds: Phase.BillingThresholds | null;
-
         /**
          * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
          */
         collection_method: Phase.CollectionMethod | null;
 
-        /**
-         * ID of the coupon to use during this phase of the subscription schedule.
-         */
-        coupon: string | Stripe.Coupon | Stripe.DeletedCoupon | null;
-
         /**
          * 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).
          */
@@ -443,18 +416,6 @@ declare module 'stripe' {
 
         type BillingCycleAnchor = 'automatic' | 'phase_start';
 
-        interface BillingThresholds {
-          /**
-           * Monetary threshold that triggers the subscription to create an invoice
-           */
-          amount_gte: number | null;
-
-          /**
-           * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
-           */
-          reset_billing_cycle_anchor: boolean | null;
-        }
-
         type CollectionMethod = 'charge_automatically' | 'send_invoice';
 
         interface Discount {
@@ -512,11 +473,6 @@ declare module 'stripe' {
         }
 
         interface Item {
-          /**
-           * Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
-           */
-          billing_thresholds: Item.BillingThresholds | null;
-
           /**
            * The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
            */
@@ -549,13 +505,6 @@ declare module 'stripe' {
         }
 
         namespace Item {
-          interface BillingThresholds {
-            /**
-             * Usage threshold that triggers the subscription to create an invoice
-             */
-            usage_gte: number | null;
-          }
-
           interface Discount {
             /**
              * ID of the coupon to create a new discount for.