stripe 18.2.1 → 18.3.0-beta.2

package/types/BalanceSettings.d.ts

@@ -0,0 +1,89 @@
+// 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';
+
+      /**
+       * 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;
+    }
+
+    namespace BalanceSettings {
+      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_anchor?: number;
+
+          /**
+           * The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly.
+           */
+          weekly_anchor?: Schedule.WeeklyAnchor;
+        }
+
+        namespace Schedule {
+          type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
+
+          type WeeklyAnchor =
+            | 'friday'
+            | 'monday'
+            | '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,108 @@
+// 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 {
+      /**
+       * 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;
+
+      /**
+       * 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 {
+        /**
+         * 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 day of the month when available funds are paid out, specified as a number 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_anchor?: number;
+
+          /**
+           * The day of the week when available funds are paid out (required and applicable only if `interval` is `weekly`.)
+           */
+          weekly_anchor?: Schedule.WeeklyAnchor;
+        }
+
+        namespace Schedule {
+          type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
+
+          type WeeklyAnchor =
+            | 'friday'
+            | 'monday'
+            | '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?: 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/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.
          */

package/types/Billing/CreditBalanceSummaryResource.d.ts

@@ -4,15 +4,20 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Billing {
       interface CreditBalanceSummaryRetrieveParams {
+        /**
+         * The filter criteria for the credit balance summary.
+         */
+        filter: CreditBalanceSummaryRetrieveParams.Filter;
+
         /**
          * The customer for which to fetch credit balance summary.
          */
-        customer: string;
+        customer?: string;
 
         /**
-         * The filter criteria for the credit balance summary.
+         * The account for which to fetch credit balance summary.
          */
-        filter: CreditBalanceSummaryRetrieveParams.Filter;
+        customer_account?: string;
 
         /**
          * Specifies which fields in the response should be expanded.

package/types/Billing/CreditBalanceTransactionsResource.d.ts

@@ -11,15 +11,20 @@ declare module 'stripe' {
       }
 
       interface CreditBalanceTransactionListParams extends PaginationParams {
+        /**
+         * The credit grant for which to fetch credit balance transactions.
+         */
+        credit_grant?: string;
+
         /**
          * The customer for which to fetch credit balance transactions.
          */
-        customer: string;
+        customer?: string;
 
         /**
-         * The credit grant for which to fetch credit balance transactions.
+         * The account for which to fetch credit balance transactions.
          */
-        credit_grant?: string;
+        customer_account?: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -45,7 +50,10 @@ declare module 'stripe' {
          * Retrieve a list of credit balance transactions.
          */
         list(
-          params: CreditBalanceTransactionListParams,
+          params?: CreditBalanceTransactionListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Billing.CreditBalanceTransaction>;
+        list(
           options?: RequestOptions
         ): ApiListPromise<Stripe.Billing.CreditBalanceTransaction>;
       }

package/types/Billing/CreditGrants.d.ts

@@ -38,6 +38,11 @@ declare module 'stripe' {
          */
         customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
+        /**
+         * ID of the account receiving the billing credits
+         */
+        customer_account?: string | null;
+
         /**
          * The time when the billing credits become effective-when they're eligible for use.
          */

package/types/Billing/CreditGrantsResource.d.ts

@@ -22,7 +22,12 @@ declare module 'stripe' {
         /**
          * ID of the customer to receive the billing credits.
          */
-        customer: string;
+        customer?: string;
+
+        /**
+         * ID of the account to receive the billing credits.
+         */
+        customer_account?: string;
 
         /**
          * The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
@@ -145,6 +150,11 @@ declare module 'stripe' {
          */
         customer?: string;
 
+        /**
+         * Only return credit grants for this account.
+         */
+        customer_account?: string;
+
         /**
          * Specifies which fields in the response should be expanded.
          */

package/types/BillingPortal/Sessions.d.ts

@@ -45,6 +45,11 @@ declare module 'stripe' {
          */
         customer: string;
 
+        /**
+         * The ID of the account for this session.
+         */
+        customer_account?: string | null;
+
         /**
          * Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
          */

package/types/BillingPortal/SessionsResource.d.ts

@@ -4,15 +4,20 @@ declare module 'stripe' {
   namespace Stripe {
     namespace BillingPortal {
       interface SessionCreateParams {
+        /**
+         * The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
+         */
+        configuration?: string;
+
         /**
          * The ID of an existing customer.
          */
-        customer: string;
+        customer?: string;
 
         /**
-         * The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
+         * The ID of an existing account.
          */
-        configuration?: string;
+        customer_account?: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -256,7 +261,10 @@ declare module 'stripe' {
          * Creates a session of the customer portal.
          */
         create(
-          params: SessionCreateParams,
+          params?: SessionCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.BillingPortal.Session>>;
+        create(
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.BillingPortal.Session>>;
       }

package/types/Capital/FinancingOffers.d.ts

@@ -0,0 +1,188 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      /**
+       * This is an object representing an offer of financing from
+       * Stripe Capital to a Connect subaccount.
+       */
+      interface FinancingOffer {
+        /**
+         * A unique identifier for the financing object.
+         */
+        id: string;
+
+        /**
+         * The object type: financing_offer.
+         */
+        object: 'capital.financing_offer';
+
+        /**
+         * This is an object representing the terms of an offer of financing from
+         * Stripe Capital to a Connected account. This resource represents
+         * the terms accepted by the Connected account, which may differ from those
+         * offered.
+         */
+        accepted_terms?: FinancingOffer.AcceptedTerms;
+
+        /**
+         * The ID of the merchant associated with this financing object.
+         */
+        account: string;
+
+        /**
+         * The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
+         */
+        charged_off_at?: number;
+
+        /**
+         * Time at which the offer was created. Given in seconds since unix epoch.
+         */
+        created: number;
+
+        /**
+         * Time at which the offer expires. Given in seconds since unix epoch.
+         */
+        expires_after: number;
+
+        /**
+         * The type of financing being offered.
+         */
+        financing_type?: FinancingOffer.FinancingType;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * 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;
+
+        /**
+         * This is an object representing the terms of an offer of financing from
+         * Stripe Capital to a Connected account. This resource represents
+         * both the terms offered to the Connected account.
+         */
+        offered_terms?: FinancingOffer.OfferedTerms;
+
+        /**
+         * Financing product identifier.
+         */
+        product_type?: FinancingOffer.ProductType;
+
+        /**
+         * The ID of the financing offer that replaced this offer.
+         */
+        replacement?: string;
+
+        /**
+         * The ID of the financing offer that this offer is a replacement for.
+         */
+        replacement_for?: string;
+
+        /**
+         * The current status of the offer.
+         */
+        status: FinancingOffer.Status;
+
+        /**
+         * See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
+         */
+        type?: FinancingOffer.Type;
+      }
+
+      namespace FinancingOffer {
+        interface AcceptedTerms {
+          /**
+           * Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+           */
+          advance_amount: number;
+
+          /**
+           * Currency that the financing offer is transacted in. For example, `usd`.
+           */
+          currency: string;
+
+          /**
+           * Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+           */
+          fee_amount: number;
+
+          /**
+           * Populated when the `product_type` of the `financingoffer` is `refill`.
+           * Represents the discount amount on remaining premium for the existing loan at payout time.
+           */
+          previous_financing_fee_discount_amount: number | null;
+
+          /**
+           * Per-transaction rate at which Stripe will withhold funds to repay the financing.
+           */
+          withhold_rate: number;
+        }
+
+        type FinancingType = 'cash_advance' | 'flex_loan';
+
+        interface OfferedTerms {
+          /**
+           * Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+           */
+          advance_amount: number;
+
+          /**
+           * Describes the type of user the offer is being extended to.
+           */
+          campaign_type: OfferedTerms.CampaignType;
+
+          /**
+           * Currency that the financing offer is transacted in. For example, `usd`.
+           */
+          currency: string;
+
+          /**
+           * Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+           */
+          fee_amount: number;
+
+          /**
+           * Populated when the `product_type` of the `financingoffer` is `refill`.
+           * Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
+           * is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
+           * and the remaining fee.
+           */
+          previous_financing_fee_discount_rate: number | null;
+
+          /**
+           * Per-transaction rate at which Stripe will withhold funds to repay the financing.
+           */
+          withhold_rate: number;
+        }
+
+        namespace OfferedTerms {
+          type CampaignType =
+            | 'newly_eligible_user'
+            | 'previously_eligible_user'
+            | 'repeat_user';
+        }
+
+        type ProductType = 'refill' | 'standard';
+
+        type Status =
+          | 'accepted'
+          | 'canceled'
+          | 'completed'
+          | 'delivered'
+          | 'expired'
+          | 'fully_repaid'
+          | 'paid_out'
+          | 'rejected'
+          | 'replaced'
+          | 'undelivered';
+
+        type Type = 'cash_advance' | 'fixed_term_loan' | 'flex_loan';
+      }
+    }
+  }
+}

package/types/Capital/FinancingOffersResource.d.ts

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Capital {
+      interface FinancingOfferRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface FinancingOfferListParams extends PaginationParams {
+        /**
+         * limit list to offers belonging to given connected account
+         */
+        connected_account?: string;
+
+        /**
+         * Only return offers that were created during the given date interval.
+         */
+        created?: Stripe.RangeQueryParam | number;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * limit list to offers with given status
+         */
+        status?: FinancingOfferListParams.Status;
+      }
+
+      namespace FinancingOfferListParams {
+        type Status =
+          | 'accepted'
+          | 'canceled'
+          | 'completed'
+          | 'delivered'
+          | 'expired'
+          | 'fully_repaid'
+          | 'paid_out'
+          | 'rejected'
+          | 'revoked'
+          | 'undelivered';
+      }
+
+      interface FinancingOfferMarkDeliveredParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class FinancingOffersResource {
+        /**
+         * Get the details of the financing offer
+         */
+        retrieve(
+          id: string,
+          params?: FinancingOfferRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+
+        /**
+         * Retrieves the financing offers available for Connected accounts that belong to your platform.
+         */
+        list(
+          params?: FinancingOfferListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Capital.FinancingOffer>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Capital.FinancingOffer>;
+
+        /**
+         * Acknowledges that platform has received and delivered the financing_offer to
+         * the intended merchant recipient.
+         */
+        markDelivered(
+          id: string,
+          params?: FinancingOfferMarkDeliveredParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+        markDelivered(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Capital.FinancingOffer>>;
+      }
+    }
+  }
+}