stripe 18.5.0 → 18.6.0-alpha.2

package/types/BalanceSettings.d.ts

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Options for customizing account balances and payout settings for a Stripe platform's connected accounts.
+     *
+     * This API is only available for users enrolled in the public preview for Accounts v2 on Stripe Connect.
+     * If you are not in this preview, please use the [Accounts v1 API](https://docs.stripe.com/api/accounts?api-version=2025-03-31.basil)
+     * to manage your connected accounts' balance settings instead.
+     */
+    interface BalanceSettings {
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'balance_settings';
+
+      payments: BalanceSettings.Payments;
+    }
+
+    namespace BalanceSettings {
+      interface Payments {
+        /**
+         * A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
+         */
+        debit_negative_balances: boolean | null;
+
+        /**
+         * Settings specific to the account's payouts.
+         */
+        payouts: Payments.Payouts | null;
+
+        settlement_timing: Payments.SettlementTiming;
+      }
+
+      namespace Payments {
+        interface Payouts {
+          /**
+           * Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation for details.
+           */
+          schedule: Payouts.Schedule | null;
+
+          /**
+           * The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
+           */
+          statement_descriptor: string | null;
+
+          /**
+           * Whether the funds in this account can be paid out.
+           */
+          status: Payouts.Status;
+        }
+
+        namespace Payouts {
+          interface Schedule {
+            /**
+             * How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
+             */
+            interval: Schedule.Interval | null;
+
+            /**
+             * The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
+             */
+            monthly_payout_days?: Array<number>;
+
+            /**
+             * The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
+             */
+            weekly_payout_days?: Array<Schedule.WeeklyPayoutDay>;
+          }
+
+          namespace Schedule {
+            type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
+
+            type WeeklyPayoutDay =
+              | 'friday'
+              | 'monday'
+              | 'saturday'
+              | 'sunday'
+              | 'thursday'
+              | 'tuesday'
+              | 'wednesday';
+          }
+
+          type Status = 'disabled' | 'enabled';
+        }
+
+        interface SettlementTiming {
+          /**
+           * The number of days charge funds are held before becoming available.
+           */
+          delay_days: number;
+        }
+      }
+    }
+  }
+}

package/types/BalanceSettingsResource.d.ts

@@ -0,0 +1,119 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface BalanceSettingsRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface BalanceSettingsUpdateParams {
+      /**
+       * Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance).
+       */
+      payments: BalanceSettingsUpdateParams.Payments;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    namespace BalanceSettingsUpdateParams {
+      interface Payments {
+        /**
+         * A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances).
+         */
+        debit_negative_balances?: boolean;
+
+        /**
+         * Settings specific to the account's payouts.
+         */
+        payouts?: Payments.Payouts;
+
+        /**
+         * Settings related to the account's balance settlement timing.
+         */
+        settlement_timing?: Payments.SettlementTiming;
+      }
+
+      namespace Payments {
+        interface Payouts {
+          /**
+           * Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation.
+           */
+          schedule?: Payouts.Schedule;
+
+          /**
+           * The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
+           */
+          statement_descriptor?: string;
+        }
+
+        namespace Payouts {
+          interface Schedule {
+            /**
+             * How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
+             */
+            interval?: Schedule.Interval;
+
+            /**
+             * The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
+             */
+            monthly_payout_days?: Array<number>;
+
+            /**
+             * The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. (required and applicable only if `interval` is `weekly`.)
+             */
+            weekly_payout_days?: Array<Schedule.WeeklyPayoutDay>;
+          }
+
+          namespace Schedule {
+            type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
+
+            type WeeklyPayoutDay =
+              | 'friday'
+              | 'monday'
+              | 'saturday'
+              | 'sunday'
+              | 'thursday'
+              | 'tuesday'
+              | 'wednesday';
+          }
+        }
+
+        interface SettlementTiming {
+          /**
+           * The number of days charge funds are held before becoming available. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `payouts.schedule.interval` is `manual`. [Learn more about controlling payout delay days](https://docs.stripe.com/connect/manage-payout-schedule).
+           */
+          delay_days_override?: number;
+        }
+      }
+    }
+
+    class BalanceSettingsResource {
+      /**
+       * Retrieves balance settings for a given connected account.
+       *  Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
+       */
+      retrieve(
+        params?: BalanceSettingsRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
+      retrieve(
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
+
+      /**
+       * Updates balance settings for a given connected account.
+       *  Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
+       */
+      update(
+        params: BalanceSettingsUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
+    }
+  }
+}

package/types/Billing/AlertTriggereds.d.ts

@@ -22,11 +22,26 @@ declare module 'stripe' {
          */
         created: number;
 
+        /**
+         * Currency for the threshold value
+         */
+        currency?: string | null;
+
+        /**
+         * Custom pricing unit for the threshold value
+         */
+        custom_pricing_unit?: string | null;
+
         /**
          * ID of customer for which the alert triggered
          */
         customer: string;
 
+        /**
+         * External customer ID for the customer for which the alert triggered
+         */
+        external_customer_id?: string | null;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
@@ -35,7 +50,7 @@ declare module 'stripe' {
         /**
          * The value triggering the alert
          */
-        value: number;
+        value: string;
       }
     }
   }

package/types/Billing/Alerts.d.ts

@@ -20,7 +20,12 @@ declare module 'stripe' {
         /**
          * Defines the type of the alert.
          */
-        alert_type: 'usage_threshold';
+        alert_type: Alert.AlertType;
+
+        /**
+         * Encapsulates configuration of the alert to monitor billing credit balance.
+         */
+        credit_balance_threshold?: Alert.CreditBalanceThreshold | null;
 
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
@@ -44,6 +49,116 @@ declare module 'stripe' {
       }
 
       namespace Alert {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+
+        interface CreditBalanceThreshold {
+          /**
+           * The filters allow limiting the scope of this credit balance alert. You must specify only a customer filter at this time.
+           */
+          filters: Array<CreditBalanceThreshold.Filter> | null;
+
+          lte: CreditBalanceThreshold.Lte;
+        }
+
+        namespace CreditBalanceThreshold {
+          interface Filter {
+            /**
+             * Limit the scope of the alert to this customer ID
+             */
+            customer: string | Stripe.Customer | null;
+
+            type: Filter.Type;
+          }
+
+          namespace Filter {
+            type Type = 'customer' | 'tenant';
+          }
+
+          interface Lte {
+            /**
+             * The type of this balance. We currently only support `monetary` amounts.
+             */
+            balance_type: Lte.BalanceType;
+
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: Lte.CustomPricingUnit | null;
+
+            /**
+             * The monetary amount.
+             */
+            monetary: Lte.Monetary | null;
+          }
+
+          namespace Lte {
+            type BalanceType = 'custom_pricing_unit' | 'monetary';
+
+            interface CustomPricingUnit {
+              /**
+               * The custom pricing unit object.
+               */
+              custom_pricing_unit_details: CustomPricingUnit.CustomPricingUnitDetails | null;
+
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+
+              /**
+               * A positive decimal string representing the amount.
+               */
+              value: string;
+            }
+
+            namespace CustomPricingUnit {
+              interface CustomPricingUnitDetails {
+                /**
+                 * Time at which the object was created. Measured in seconds since the Unix epoch.
+                 */
+                created: number;
+
+                /**
+                 * The name of the custom pricing unit.
+                 */
+                display_name: string;
+
+                /**
+                 * Unique identifier for the object.
+                 */
+                id: string;
+
+                /**
+                 * A lookup key for the custom pricing unit.
+                 */
+                lookup_key: string | null;
+
+                /**
+                 * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+                 */
+                metadata: Stripe.Metadata;
+
+                /**
+                 * The status of the custom pricing unit.
+                 */
+                status: string;
+              }
+            }
+
+            interface Monetary {
+              /**
+               * 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).
+               */
+              currency: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: number;
+            }
+          }
+        }
+
         type Status = 'active' | 'archived' | 'inactive';
 
         interface UsageThreshold {

package/types/Billing/AlertsResource.d.ts

@@ -7,13 +7,18 @@ declare module 'stripe' {
         /**
          * The type of alert to create.
          */
-        alert_type: 'usage_threshold';
+        alert_type: AlertCreateParams.AlertType;
 
         /**
          * The title of the alert.
          */
         title: string;
 
+        /**
+         * The configuration of the credit balance threshold.
+         */
+        credit_balance_threshold?: AlertCreateParams.CreditBalanceThreshold;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -26,6 +31,83 @@ declare module 'stripe' {
       }
 
       namespace AlertCreateParams {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+
+        interface CreditBalanceThreshold {
+          /**
+           * The filters allows limiting the scope of this credit balance alert. You must specify a customer filter at this time.
+           */
+          filters?: Array<CreditBalanceThreshold.Filter>;
+
+          /**
+           * Defines at which value the alert will fire.
+           */
+          lte: CreditBalanceThreshold.Lte;
+        }
+
+        namespace CreditBalanceThreshold {
+          interface Filter {
+            /**
+             * Limit the scope to this credit balance alert only to this customer.
+             */
+            customer?: string;
+
+            /**
+             * What type of filter is being applied to this credit balance alert.
+             */
+            type: Filter.Type;
+          }
+
+          namespace Filter {
+            type Type = 'customer' | 'tenant';
+          }
+
+          interface Lte {
+            /**
+             * Specify the type of this balance. We currently only support `monetary` billing credits.
+             */
+            balance_type: Lte.BalanceType;
+
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: Lte.CustomPricingUnit;
+
+            /**
+             * The monetary amount.
+             */
+            monetary?: Lte.Monetary;
+          }
+
+          namespace Lte {
+            type BalanceType = 'custom_pricing_unit' | 'monetary';
+
+            interface CustomPricingUnit {
+              /**
+               * The ID of the custom pricing unit.
+               */
+              id: string;
+
+              /**
+               * A positive decimal string representing the amount of the custom pricing unit threshold.
+               */
+              value: string;
+            }
+
+            interface Monetary {
+              /**
+               * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
+               */
+              currency: string;
+
+              /**
+               * An integer representing the amount of the threshold.
+               */
+              value: number;
+            }
+          }
+        }
+
         interface UsageThreshold {
           /**
            * The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
@@ -74,7 +156,12 @@ declare module 'stripe' {
         /**
          * Filter results to only include this type of alert.
          */
-        alert_type?: 'usage_threshold';
+        alert_type?: AlertListParams.AlertType;
+
+        /**
+         * Filter results to only include alerts for the given customer.
+         */
+        customer?: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -87,6 +174,10 @@ declare module 'stripe' {
         meter?: string;
       }
 
+      namespace AlertListParams {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+      }
+
       interface AlertActivateParams {
         /**
          * Specifies which fields in the response should be expanded.

package/types/Billing/CreditBalanceSummary.d.ts

@@ -22,6 +22,11 @@ declare module 'stripe' {
          */
         customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
+        /**
+         * The account the balance is for.
+         */
+        customer_account?: string | null;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
@@ -37,6 +42,11 @@ declare module 'stripe' {
 
         namespace Balance {
           interface AvailableBalance {
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: AvailableBalance.CustomPricingUnit | null;
+
             /**
              * The monetary amount.
              */
@@ -45,10 +55,61 @@ declare module 'stripe' {
             /**
              * The type of this amount. We currently only support `monetary` billing credits.
              */
-            type: 'monetary';
+            type: AvailableBalance.Type;
           }
 
           namespace AvailableBalance {
+            interface CustomPricingUnit {
+              /**
+               * The custom pricing unit object.
+               */
+              custom_pricing_unit_details: CustomPricingUnit.CustomPricingUnitDetails | null;
+
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: string;
+            }
+
+            namespace CustomPricingUnit {
+              interface CustomPricingUnitDetails {
+                /**
+                 * Time at which the object was created. Measured in seconds since the Unix epoch.
+                 */
+                created: number;
+
+                /**
+                 * The name of the custom pricing unit.
+                 */
+                display_name: string;
+
+                /**
+                 * Unique identifier for the object.
+                 */
+                id: string;
+
+                /**
+                 * A lookup key for the custom pricing unit.
+                 */
+                lookup_key: string | null;
+
+                /**
+                 * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+                 */
+                metadata: Stripe.Metadata;
+
+                /**
+                 * The status of the custom pricing unit.
+                 */
+                status: string;
+              }
+            }
+
             interface Monetary {
               /**
                * 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).
@@ -60,9 +121,16 @@ declare module 'stripe' {
                */
               value: number;
             }
+
+            type Type = 'custom_pricing_unit' | 'monetary';
           }
 
           interface LedgerBalance {
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: LedgerBalance.CustomPricingUnit | null;
+
             /**
              * The monetary amount.
              */
@@ -71,10 +139,61 @@ declare module 'stripe' {
             /**
              * The type of this amount. We currently only support `monetary` billing credits.
              */
-            type: 'monetary';
+            type: LedgerBalance.Type;
           }
 
           namespace LedgerBalance {
+            interface CustomPricingUnit {
+              /**
+               * The custom pricing unit object.
+               */
+              custom_pricing_unit_details: CustomPricingUnit.CustomPricingUnitDetails | null;
+
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+
+              /**
+               * A positive integer representing the amount.
+               */
+              value: string;
+            }
+
+            namespace CustomPricingUnit {
+              interface CustomPricingUnitDetails {
+                /**
+                 * Time at which the object was created. Measured in seconds since the Unix epoch.
+                 */
+                created: number;
+
+                /**
+                 * The name of the custom pricing unit.
+                 */
+                display_name: string;
+
+                /**
+                 * Unique identifier for the object.
+                 */
+                id: string;
+
+                /**
+                 * A lookup key for the custom pricing unit.
+                 */
+                lookup_key: string | null;
+
+                /**
+                 * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+                 */
+                metadata: Stripe.Metadata;
+
+                /**
+                 * The status of the custom pricing unit.
+                 */
+                status: string;
+              }
+            }
+
             interface Monetary {
               /**
                * 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).
@@ -86,6 +205,8 @@ declare module 'stripe' {
                */
               value: number;
             }
+
+            type Type = 'custom_pricing_unit' | 'monetary';
           }
         }
       }