stripe 16.2.0 → 16.4.0-beta.1

package/types/AccountsResource.d.ts

@@ -82,6 +82,11 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
+      /**
+       * A hash to configure risk controls on the account. Please see [this page for more details](https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts).
+       */
+      risk_controls?: AccountCreateParams.RiskControls;
+
       /**
        * Options for customizing how the account functions within Stripe.
        */
@@ -359,11 +364,26 @@ declare module 'stripe' {
          */
         paynow_payments?: Capabilities.PaynowPayments;
 
+        /**
+         * The paypal_payments capability.
+         */
+        paypal_payments?: Capabilities.PaypalPayments;
+
+        /**
+         * The payto_payments capability.
+         */
+        payto_payments?: Capabilities.PaytoPayments;
+
         /**
          * The promptpay_payments capability.
          */
         promptpay_payments?: Capabilities.PromptpayPayments;
 
+        /**
+         * The rechnung_payments capability.
+         */
+        rechnung_payments?: Capabilities.RechnungPayments;
+
         /**
          * The revolut_pay_payments capability.
          */
@@ -662,6 +682,20 @@ declare module 'stripe' {
           requested?: boolean;
         }
 
+        interface PaypalPayments {
+          /**
+           * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
+           */
+          requested?: boolean;
+        }
+
+        interface PaytoPayments {
+          /**
+           * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
+           */
+          requested?: boolean;
+        }
+
         interface PromptpayPayments {
           /**
            * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -669,6 +703,13 @@ declare module 'stripe' {
           requested?: boolean;
         }
 
+        interface RechnungPayments {
+          /**
+           * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
+           */
+          requested?: boolean;
+        }
+
         interface RevolutPayPayments {
           /**
            * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -924,6 +965,16 @@ declare module 'stripe' {
       }
 
       interface Controller {
+        /**
+         * A hash of configuration describing the Connect application that controls the account.
+         */
+        application?: Controller.Application;
+
+        /**
+         * Properties of the account's dashboard.
+         */
+        dashboard?: Controller.Dashboard;
+
         /**
          * A hash of configuration for who pays Stripe fees for product usage on this account.
          */
@@ -946,6 +997,34 @@ declare module 'stripe' {
       }
 
       namespace Controller {
+        interface Application {
+          /**
+           * Whether the controller is liable for losses on this account. For details, see [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).
+           */
+          loss_liable: boolean;
+
+          /**
+           * Whether the controller owns onboarding for this account.
+           */
+          onboarding_owner?: boolean;
+
+          /**
+           * Whether the controller has pricing controls for this account.
+           */
+          pricing_controls?: boolean;
+        }
+
+        interface Dashboard {
+          /**
+           * Whether this account should have access to the full Stripe Dashboard (`full`), to the Express Dashboard (`express`), or to no Stripe-hosted dashboard (`none`). Defaults to `full`.
+           */
+          type?: Dashboard.Type;
+        }
+
+        namespace Dashboard {
+          type Type = 'express' | 'full' | 'none';
+        }
+
         interface Fees {
           /**
            * A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
@@ -1310,6 +1389,36 @@ declare module 'stripe' {
         }
       }
 
+      interface RiskControls {
+        /**
+         * Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
+         */
+        charges?: RiskControls.Charges;
+
+        /**
+         * Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
+         */
+        payouts?: RiskControls.Payouts;
+      }
+
+      namespace RiskControls {
+        interface Charges {
+          /**
+           * To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
+           * There can be a delay before the risk control is paused or unpaused.
+           */
+          pause_requested?: boolean;
+        }
+
+        interface Payouts {
+          /**
+           * To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
+           * There can be a delay before the risk control is paused or unpaused.
+           */
+          pause_requested?: boolean;
+        }
+      }
+
       interface Settings {
         /**
          * Settings specific to Bacs Direct Debit.
@@ -1341,6 +1450,11 @@ declare module 'stripe' {
          */
         payouts?: Settings.Payouts;
 
+        /**
+         * Settings specific to the account's tax forms.
+         */
+        tax_forms?: Settings.TaxForms;
+
         /**
          * Settings specific to the account's Treasury FinancialAccounts.
          */
@@ -1510,6 +1624,13 @@ declare module 'stripe' {
           }
         }
 
+        interface TaxForms {
+          /**
+           * Whether the account opted out of receiving their tax forms by postal delivery.
+           */
+          consented_to_paperless_delivery?: boolean;
+        }
+
         interface Treasury {
           /**
            * Details on the account's acceptance of the Stripe Treasury Services Agreement.
@@ -1644,6 +1765,11 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
+      /**
+       * A hash to configure risk controls on the account. Please see [this page for more details](https://docs.stripe.com/connect/pausing-payments-or-payouts-on-connected-accounts).
+       */
+      risk_controls?: AccountUpdateParams.RiskControls;
+
       /**
        * Options for customizing how the account functions within Stripe.
        */
@@ -1954,11 +2080,26 @@ declare module 'stripe' {
          */
         paynow_payments?: Capabilities.PaynowPayments;
 
+        /**
+         * The paypal_payments capability.
+         */
+        paypal_payments?: Capabilities.PaypalPayments;
+
+        /**
+         * The payto_payments capability.
+         */
+        payto_payments?: Capabilities.PaytoPayments;
+
         /**
          * The promptpay_payments capability.
          */
         promptpay_payments?: Capabilities.PromptpayPayments;
 
+        /**
+         * The rechnung_payments capability.
+         */
+        rechnung_payments?: Capabilities.RechnungPayments;
+
         /**
          * The revolut_pay_payments capability.
          */
@@ -2257,6 +2398,20 @@ declare module 'stripe' {
           requested?: boolean;
         }
 
+        interface PaypalPayments {
+          /**
+           * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
+           */
+          requested?: boolean;
+        }
+
+        interface PaytoPayments {
+          /**
+           * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
+           */
+          requested?: boolean;
+        }
+
         interface PromptpayPayments {
           /**
            * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -2264,6 +2419,13 @@ declare module 'stripe' {
           requested?: boolean;
         }
 
+        interface RechnungPayments {
+          /**
+           * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
+           */
+          requested?: boolean;
+        }
+
         interface RevolutPayPayments {
           /**
            * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -2852,6 +3014,36 @@ declare module 'stripe' {
         }
       }
 
+      interface RiskControls {
+        /**
+         * Represents the risk control status of charges. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
+         */
+        charges?: RiskControls.Charges;
+
+        /**
+         * Represents the risk control status of payouts. Please see [this page for more details](https://stripe.com/docs/connect/pausing-payments-or-payouts-on-connected-accounts).
+         */
+        payouts?: RiskControls.Payouts;
+      }
+
+      namespace RiskControls {
+        interface Charges {
+          /**
+           * To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
+           * There can be a delay before the risk control is paused or unpaused.
+           */
+          pause_requested?: boolean;
+        }
+
+        interface Payouts {
+          /**
+           * To request to pause a risk control, pass `true`. To request to unpause a risk control, pass `false`.
+           * There can be a delay before the risk control is paused or unpaused.
+           */
+          pause_requested?: boolean;
+        }
+      }
+
       interface Settings {
         /**
          * Settings specific to Bacs Direct Debit payments.
@@ -2888,6 +3080,11 @@ declare module 'stripe' {
          */
         payouts?: Settings.Payouts;
 
+        /**
+         * Settings specific to the account's tax forms.
+         */
+        tax_forms?: Settings.TaxForms;
+
         /**
          * Settings specific to the account's Treasury FinancialAccounts.
          */
@@ -3064,6 +3261,13 @@ declare module 'stripe' {
           }
         }
 
+        interface TaxForms {
+          /**
+           * Whether the account opted out of receiving their tax forms by postal delivery.
+           */
+          consented_to_paperless_delivery?: boolean;
+        }
+
         interface Treasury {
           /**
            * Details on the account's acceptance of the Stripe Treasury Services Agreement.

package/types/BillingPortal/Sessions.d.ts

@@ -17,7 +17,7 @@ declare module 'stripe' {
        * Create sessions on-demand when customers intend to manage their subscriptions
        * and billing details.
        *
-       * Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
+       * Related guide: [Customer management](https://stripe.com/customer-management)
        */
       interface 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.
+           */
+          advance_amount: number;
+
+          /**
+           * Currency that the financing offer is transacted in. For example, `usd`.
+           */
+          currency: string;
+
+          /**
+           * Fixed fee amount, in minor units.
+           */
+          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.
+           */
+          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.
+           */
+          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' | '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>>;
+      }
+    }
+  }
+}