stripe 18.5.0-beta.2 → 18.6.0-beta.1

package/types/AccountSessions.d.ts

@@ -50,6 +50,8 @@ declare module 'stripe' {
 
         account_onboarding: Components.AccountOnboarding;
 
+        balance_report: Components.BalanceReport;
+
         balances: Components.Balances;
 
         capital_financing?: Components.CapitalFinancing | null;
@@ -80,6 +82,10 @@ declare module 'stripe' {
 
         payments: Components.Payments;
 
+        payout_details: Components.PayoutDetails;
+
+        payout_reconciliation_report: Components.PayoutReconciliationReport;
+
         payouts: Components.Payouts;
 
         payouts_list: Components.PayoutsList;
@@ -136,6 +142,19 @@ declare module 'stripe' {
           }
         }
 
+        interface BalanceReport {
+          /**
+           * Whether the embedded component is enabled.
+           */
+          enabled: boolean;
+
+          features: BalanceReport.Features;
+        }
+
+        namespace BalanceReport {
+          interface Features {}
+        }
+
         interface Balances {
           /**
            * Whether the embedded component is enabled.
@@ -526,6 +545,32 @@ declare module 'stripe' {
           }
         }
 
+        interface PayoutDetails {
+          /**
+           * Whether the embedded component is enabled.
+           */
+          enabled: boolean;
+
+          features: PayoutDetails.Features;
+        }
+
+        namespace PayoutDetails {
+          interface Features {}
+        }
+
+        interface PayoutReconciliationReport {
+          /**
+           * Whether the embedded component is enabled.
+           */
+          enabled: boolean;
+
+          features: PayoutReconciliationReport.Features;
+        }
+
+        namespace PayoutReconciliationReport {
+          interface Features {}
+        }
+
         interface Payouts {
           /**
            * Whether the embedded component is enabled.

package/types/AccountSessionsResource.d.ts

@@ -41,6 +41,11 @@ declare module 'stripe' {
          */
         app_viewport?: Components.AppViewport;
 
+        /**
+         * Configuration for the [balance report](https://docs.stripe.com/connect/supported-embedded-components/financial-reports#balance-report) embedded component.
+         */
+        balance_report?: Components.BalanceReport;
+
         /**
          * Configuration for the [balances](https://docs.stripe.com/connect/supported-embedded-components/balances/) embedded component.
          */
@@ -131,6 +136,16 @@ declare module 'stripe' {
          */
         payments?: Components.Payments;
 
+        /**
+         * Configuration for the [payout details](https://docs.stripe.com/connect/supported-embedded-components/payout-details/) embedded component.
+         */
+        payout_details?: Components.PayoutDetails;
+
+        /**
+         * Configuration for the [payout reconciliation report](https://docs.stripe.com/connect/supported-embedded-components/financial-reports#payout-reconciliation-report) embedded component.
+         */
+        payout_reconciliation_report?: Components.PayoutReconciliationReport;
+
         /**
          * Configuration for the [payouts](https://docs.stripe.com/connect/supported-embedded-components/payouts/) embedded component.
          */
@@ -267,6 +282,22 @@ declare module 'stripe' {
           }
         }
 
+        interface BalanceReport {
+          /**
+           * Whether the embedded component is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * An empty list, because this embedded component has no features.
+           */
+          features?: BalanceReport.Features;
+        }
+
+        namespace BalanceReport {
+          interface Features {}
+        }
+
         interface Balances {
           /**
            * Whether the embedded component is enabled.
@@ -315,7 +346,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: CapitalFinancing.Features;
         }
@@ -331,7 +362,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: CapitalFinancingApplication.Features;
         }
@@ -347,7 +378,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: CapitalFinancingPromotion.Features;
         }
@@ -363,7 +394,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: CapitalOverview.Features;
         }
@@ -415,7 +446,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: Documents.Features;
         }
@@ -431,7 +462,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: ExportTaxTransactions.Features;
         }
@@ -705,7 +736,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: PaymentMethodSettings.Features;
         }
@@ -750,6 +781,38 @@ declare module 'stripe' {
           }
         }
 
+        interface PayoutDetails {
+          /**
+           * Whether the embedded component is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * An empty list, because this embedded component has no features.
+           */
+          features?: PayoutDetails.Features;
+        }
+
+        namespace PayoutDetails {
+          interface Features {}
+        }
+
+        interface PayoutReconciliationReport {
+          /**
+           * Whether the embedded component is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * An empty list, because this embedded component has no features.
+           */
+          features?: PayoutReconciliationReport.Features;
+        }
+
+        namespace PayoutReconciliationReport {
+          interface Features {}
+        }
+
         interface Payouts {
           /**
            * Whether the embedded component is enabled.
@@ -798,7 +861,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: PayoutsList.Features;
         }
@@ -814,7 +877,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: ProductTaxCodeSelector.Features;
         }
@@ -848,7 +911,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: ReportingChart.Features;
         }
@@ -864,7 +927,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: TaxRegistrations.Features;
         }
@@ -880,7 +943,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: TaxSettings.Features;
         }
@@ -896,7 +959,7 @@ declare module 'stripe' {
           enabled: boolean;
 
           /**
-           * The list of features enabled in the embedded component.
+           * An empty list, because this embedded component has no features.
            */
           features?: TaxThresholdMonitoring.Features;
         }

package/types/Accounts.d.ts

@@ -1010,7 +1010,7 @@ declare module 'stripe' {
         namespace Verification {
           interface Document {
             /**
-             * The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.
+             * The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](https://docs.stripe.com/file-upload#uploading-a-file).
              */
             back: string | Stripe.File | null;
 
@@ -1025,7 +1025,7 @@ declare module 'stripe' {
             details_code: string | null;
 
             /**
-             * The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.
+             * The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](https://docs.stripe.com/file-upload#uploading-a-file).
              */
             front: string | Stripe.File | null;
           }

package/types/Balance.d.ts

@@ -6,14 +6,9 @@ declare module 'stripe' {
      * This is an object representing your Stripe balance. You can retrieve it to see
      * the balance currently on your Stripe account.
      *
-     * You can also retrieve the balance history, which contains a list of
-     * [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance
-     * (charges, payouts, and so forth).
+     * The top-level `available` and `pending` comprise your "payments balance."
      *
-     * The available and pending amounts for each currency are broken down further by
-     * payment source types.
-     *
-     * Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
+     * Related guide: [Balances and settlement time](https://stripe.com/docs/payments/balances), [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
      */
     interface Balance {
       /**

package/types/BalanceSettings.d.ts

@@ -15,76 +15,82 @@ declare module 'stripe' {
        */
       object: 'balance_settings';
 
-      /**
-       * 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: BalanceSettings.Payouts | null;
-
-      settlement_timing: BalanceSettings.SettlementTiming;
+      payments: BalanceSettings.Payments;
     }
 
     namespace BalanceSettings {
-      interface Payouts {
+      interface Payments {
         /**
-         * 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.
+         * 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`.
          */
-        schedule: Payouts.Schedule | null;
+        debit_negative_balances: boolean | 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.
+         * Settings specific to the account's payouts.
          */
-        statement_descriptor: string | null;
+        payouts: Payments.Payouts | null;
 
-        /**
-         * Whether the funds in this account can be paid out.
-         */
-        status: Payouts.Status;
+        settlement_timing: Payments.SettlementTiming;
       }
 
-      namespace Payouts {
-        interface Schedule {
+      namespace Payments {
+        interface Payouts {
           /**
-           * How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
+           * 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.
            */
-          interval: Schedule.Interval | null;
+          schedule: Payouts.Schedule | 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.
+           * 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.
            */
-          monthly_payout_days?: Array<number>;
+          statement_descriptor: string | null;
 
           /**
-           * 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.
+           * Whether the funds in this account can be paid out.
            */
-          weekly_payout_days?: Array<Schedule.WeeklyPayoutDay>;
+          status: Payouts.Status;
         }
 
-        namespace Schedule {
-          type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
+        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;
 
-          type WeeklyPayoutDay =
-            | 'friday'
-            | 'monday'
-            | 'saturday'
-            | 'sunday'
-            | 'thursday'
-            | 'tuesday'
-            | 'wednesday';
-        }
+            /**
+             * 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>;
 
-        type Status = 'disabled' | 'enabled';
-      }
+            /**
+             * 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>;
+          }
 
-      interface SettlementTiming {
-        /**
-         * The number of days charge funds are held before becoming available.
-         */
-        delay_days: number;
+          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

@@ -11,76 +11,85 @@ declare module 'stripe' {
 
     interface BalanceSettingsUpdateParams {
       /**
-       * 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).
+       * Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance).
        */
-      debit_negative_balances?: boolean;
+      payments: BalanceSettingsUpdateParams.Payments;
 
       /**
        * Specifies which fields in the response should be expanded.
        */
       expand?: Array<string>;
-
-      /**
-       * Settings specific to the account's payouts.
-       */
-      payouts?: BalanceSettingsUpdateParams.Payouts;
-
-      /**
-       * Settings related to the account's balance settlement timing.
-       */
-      settlement_timing?: BalanceSettingsUpdateParams.SettlementTiming;
     }
 
     namespace BalanceSettingsUpdateParams {
-      interface Payouts {
+      interface Payments {
         /**
-         * 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.
+         * 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).
          */
-        schedule?: Payouts.Schedule;
+        debit_negative_balances?: boolean;
 
         /**
-         * 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.
+         * Settings specific to the account's payouts.
          */
-        statement_descriptor?: string;
-      }
+        payouts?: Payments.Payouts;
 
-      namespace Payouts {
-        interface Schedule {
-          /**
-           * How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
-           */
-          interval?: Schedule.Interval;
+        /**
+         * Settings related to the account's balance settlement timing.
+         */
+        settlement_timing?: Payments.SettlementTiming;
+      }
 
+      namespace Payments {
+        interface Payouts {
           /**
-           * 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`.
+           * 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.
            */
-          monthly_payout_days?: Array<number>;
+          schedule?: Payouts.Schedule;
 
           /**
-           * 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`.)
+           * 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.
            */
-          weekly_payout_days?: Array<Schedule.WeeklyPayoutDay>;
+          statement_descriptor?: string;
         }
 
-        namespace Schedule {
-          type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
-
-          type WeeklyPayoutDay =
-            | 'friday'
-            | 'monday'
-            | 'saturday'
-            | 'sunday'
-            | 'thursday'
-            | 'tuesday'
-            | 'wednesday';
+        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;
+        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;
+        }
       }
     }
 
@@ -102,7 +111,7 @@ declare module 'stripe' {
        *  Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
        */
       update(
-        params?: BalanceSettingsUpdateParams,
+        params: BalanceSettingsUpdateParams,
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
     }

package/types/Billing/AlertTriggereds.d.ts

@@ -35,7 +35,7 @@ declare module 'stripe' {
         /**
          * The value triggering the alert
          */
-        value: number;
+        value: string;
       }
     }
   }

package/types/Billing/MeterUsageRows.d.ts

@@ -40,7 +40,7 @@ declare module 'stripe' {
         } | null;
 
         /**
-         * The unique identifier for the meter.
+         * The unique identifier for the meter. Null if no meters were provided and usage was aggregated across all meters.
          */
         meter_id: string | null;
       }

package/types/Billing/Meters.d.ts

@@ -39,7 +39,7 @@ declare module 'stripe' {
         event_name: string;
 
         /**
-         * The time window to pre-aggregate meter events for, if any.
+         * The time window which meter events have been pre-aggregated for, if any.
          */
         event_time_window: Meter.EventTimeWindow | null;
 

package/types/Billing/MetersResource.d.ts

@@ -25,7 +25,7 @@ declare module 'stripe' {
         customer_mapping?: MeterCreateParams.CustomerMapping;
 
         /**
-         * The time window to pre-aggregate meter events for, if any.
+         * The time window which meter events have been pre-aggregated for, if any.
          */
         event_time_window?: MeterCreateParams.EventTimeWindow;
 

package/types/BillingPortal/Configurations.d.ts

@@ -62,6 +62,11 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata | null;
 
+        /**
+         * The name of the configuration.
+         */
+        name: string | null;
+
         /**
          * Time at which the object was last updated. Measured in seconds since the Unix epoch.
          */