stripe 16.2.0 → 16.3.0-beta.1

package/types/Events.d.ts

@@ -21,6 +21,59 @@ declare module 'stripe' {
         interface PreviousAttributes {}
       }
 
+      interface Reason {
+        automation_action?: Reason.AutomationAction;
+
+        request?: Reason.Request;
+
+        /**
+         * The type of the reason for the event.
+         */
+        type: Reason.Type;
+      }
+
+      namespace Reason {
+        interface AutomationAction {
+          stripe_send_webhook_custom_event?: AutomationAction.StripeSendWebhookCustomEvent;
+
+          /**
+           * The trigger name of the automation that triggered this action.
+           *  Please visit [Revenue and retention automations](https://docs.stripe.com/billing/automations#choose-a-trigger) for all possible trigger names.
+           */
+          trigger: string;
+
+          /**
+           * The type of the `automation_action`.
+           */
+          type: 'stripe_send_webhook_custom_event';
+        }
+
+        namespace AutomationAction {
+          interface StripeSendWebhookCustomEvent {
+            /**
+             * Set of key-value pairs attached to the action when creating an Automation.
+             */
+            custom_data: {
+              [key: string]: string;
+            } | null;
+          }
+        }
+
+        interface Request {
+          /**
+           * ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
+           */
+          id: string | null;
+
+          /**
+           * The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
+           */
+          idempotency_key: string | null;
+        }
+
+        type Type = 'automation_action' | 'request';
+      }
+
       interface Request {
         /**
          * ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
@@ -40,6 +93,8 @@ declare module 'stripe' {
         | 'account.external_account.deleted'
         | 'account.external_account.updated'
         | 'account.updated'
+        | 'account_notice.created'
+        | 'account_notice.updated'
         | 'application_fee.created'
         | 'application_fee.refund.updated'
         | 'application_fee.refunded'
@@ -48,6 +103,15 @@ declare module 'stripe' {
         | 'billing_portal.configuration.updated'
         | 'billing_portal.session.created'
         | 'capability.updated'
+        | 'capital.financing_offer.accepted'
+        | 'capital.financing_offer.canceled'
+        | 'capital.financing_offer.created'
+        | 'capital.financing_offer.expired'
+        | 'capital.financing_offer.fully_repaid'
+        | 'capital.financing_offer.paid_out'
+        | 'capital.financing_offer.rejected'
+        | 'capital.financing_offer.replacement_created'
+        | 'capital.financing_transaction.created'
         | 'cash_balance.funds_available'
         | 'charge.captured'
         | 'charge.dispute.closed'
@@ -88,7 +152,10 @@ declare module 'stripe' {
         | 'customer.source.deleted'
         | 'customer.source.expiring'
         | 'customer.source.updated'
+        | 'customer.subscription.collection_paused'
+        | 'customer.subscription.collection_resumed'
         | 'customer.subscription.created'
+        | 'customer.subscription.custom_event'
         | 'customer.subscription.deleted'
         | 'customer.subscription.paused'
         | 'customer.subscription.pending_update_applied'
@@ -108,8 +175,10 @@ declare module 'stripe' {
         | 'financial_connections.account.disconnected'
         | 'financial_connections.account.reactivated'
         | 'financial_connections.account.refreshed_balance'
+        | 'financial_connections.account.refreshed_inferred_balances'
         | 'financial_connections.account.refreshed_ownership'
         | 'financial_connections.account.refreshed_transactions'
+        | 'financial_connections.session.updated'
         | 'identity.verification_session.canceled'
         | 'identity.verification_session.created'
         | 'identity.verification_session.processing'
@@ -122,6 +191,7 @@ declare module 'stripe' {
         | 'invoice.finalized'
         | 'invoice.marked_uncollectible'
         | 'invoice.paid'
+        | 'invoice.payment.overpaid'
         | 'invoice.payment_action_required'
         | 'invoice.payment_failed'
         | 'invoice.payment_succeeded'
@@ -186,10 +256,16 @@ declare module 'stripe' {
         | 'product.updated'
         | 'promotion_code.created'
         | 'promotion_code.updated'
+        | 'quote.accept_failed'
         | 'quote.accepted'
+        | 'quote.accepting'
         | 'quote.canceled'
         | 'quote.created'
+        | 'quote.draft'
         | 'quote.finalized'
+        | 'quote.reestimate_failed'
+        | 'quote.reestimated'
+        | 'quote.stale'
         | 'radar.early_fraud_warning.created'
         | 'radar.early_fraud_warning.updated'
         | 'refund.created'
@@ -219,11 +295,13 @@ declare module 'stripe' {
         | 'subscription_schedule.expiring'
         | 'subscription_schedule.released'
         | 'subscription_schedule.updated'
+        | 'tax.form.updated'
         | 'tax.settings.updated'
         | 'tax_rate.created'
         | 'tax_rate.updated'
         | 'terminal.reader.action_failed'
         | 'terminal.reader.action_succeeded'
+        | 'terminal.reader.action_updated'
         | 'test_helpers.test_clock.advancing'
         | 'test_helpers.test_clock.created'
         | 'test_helpers.test_clock.deleted'
@@ -339,6 +417,11 @@ declare module 'stripe' {
        */
       pending_webhooks: number;
 
+      /**
+       * Information about the action that causes the event. Only present when the event is triggered by an API request or an [Automation](https://docs.stripe.com/billing/automations) action.
+       */
+      reason?: Event.Reason | null;
+
       /**
        * Information on the API request that triggers the event.
        */

package/types/FinancialConnections/AccountInferredBalances.d.ts

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
+       */
+      interface AccountInferredBalance {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.account_inferred_balance';
+
+        /**
+         * The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
+         */
+        as_of: number;
+
+        /**
+         * The balances owed to (or by) the account holder.
+         *
+         * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+         *
+         * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+         */
+        current: {
+          [key: string]: number;
+        };
+      }
+    }
+  }
+}

package/types/FinancialConnections/Accounts.d.ts

@@ -47,6 +47,11 @@ declare module 'stripe' {
          */
         display_name: string | null;
 
+        /**
+         * The state of the most recent attempt to refresh the account's inferred balance history.
+         */
+        inferred_balances_refresh?: Account.InferredBalancesRefresh | null;
+
         /**
          * The name of the institution that holds this account.
          */
@@ -103,7 +108,7 @@ declare module 'stripe' {
         /**
          * The list of data refresh subscriptions requested on this account.
          */
-        subscriptions: Array<'transactions'> | null;
+        subscriptions: Array<Account.Subscription> | null;
 
         /**
          * The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
@@ -220,6 +225,27 @@ declare module 'stripe' {
 
         type Category = 'cash' | 'credit' | 'investment' | 'other';
 
+        interface InferredBalancesRefresh {
+          /**
+           * The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
+           */
+          last_attempted_at: number;
+
+          /**
+           * Time at which the next inferred balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
+           */
+          next_refresh_available_at: number | null;
+
+          /**
+           * The status of the last refresh attempt.
+           */
+          status: InferredBalancesRefresh.Status;
+        }
+
+        namespace InferredBalancesRefresh {
+          type Status = 'failed' | 'pending' | 'succeeded';
+        }
+
         interface OwnershipRefresh {
           /**
            * The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
@@ -257,6 +283,8 @@ declare module 'stripe' {
           | 'other'
           | 'savings';
 
+        type Subscription = 'balance' | 'inferred_balances' | 'transactions';
+
         type SupportedPaymentMethodType = 'link' | 'us_bank_account';
 
         interface TransactionRefresh {

package/types/FinancialConnections/AccountsResource.d.ts

@@ -48,6 +48,13 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      interface AccountListInferredBalancesParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
       interface AccountListOwnersParams extends PaginationParams {
         /**
          * The ID of the ownership object to fetch owners from.
@@ -73,14 +80,18 @@ declare module 'stripe' {
       }
 
       namespace AccountRefreshParams {
-        type Feature = 'balance' | 'ownership' | 'transactions';
+        type Feature =
+          | 'balance'
+          | 'inferred_balances'
+          | 'ownership'
+          | 'transactions';
       }
 
       interface AccountSubscribeParams {
         /**
          * The list of account features to which you would like to subscribe.
          */
-        features: Array<'transactions'>;
+        features: Array<AccountSubscribeParams.Feature>;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -88,11 +99,15 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      namespace AccountSubscribeParams {
+        type Feature = 'balance' | 'inferred_balances' | 'transactions';
+      }
+
       interface AccountUnsubscribeParams {
         /**
          * The list of account features from which you would like to unsubscribe.
          */
-        features: Array<'transactions'>;
+        features: Array<AccountUnsubscribeParams.Feature>;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -100,6 +115,10 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      namespace AccountUnsubscribeParams {
+        type Feature = 'balance' | 'inferred_balances' | 'transactions';
+      }
+
       class AccountsResource {
         /**
          * Retrieves the details of an Financial Connections Account.
@@ -138,6 +157,19 @@ declare module 'stripe' {
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
 
+        /**
+         * Lists the recorded inferred balances for a Financial Connections Account.
+         */
+        listInferredBalances(
+          id: string,
+          params?: AccountListInferredBalancesParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.AccountInferredBalance>;
+        listInferredBalances(
+          id: string,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.AccountInferredBalance>;
+
         /**
          * Lists all owners for a given Account
          */

package/types/FinancialConnections/Institutions.d.ts

@@ -0,0 +1,93 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * An institution represents a banking institution which may be available for an end user to select in the Financial Connections authentication flow.
+       */
+      interface Institution {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.institution';
+
+        features: Institution.Features;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * The name of this institution.
+         */
+        name: string;
+
+        /**
+         * A list of routing numbers which are known to correspond to this institution.
+         */
+        routing_numbers: Array<string>;
+
+        /**
+         * The status of this institution in the Financial Connections authentication flow.
+         */
+        status: Institution.Status;
+
+        /**
+         * The URL for this institution's website.
+         */
+        url: string | null;
+      }
+
+      namespace Institution {
+        interface Features {
+          balances: Features.Balances;
+
+          ownership: Features.Ownership;
+
+          payment_method: Features.PaymentMethod;
+
+          transactions: Features.Transactions;
+        }
+
+        namespace Features {
+          interface Balances {
+            /**
+             * Whether the given feature is supported by this institution.
+             */
+            supported: boolean;
+          }
+
+          interface Ownership {
+            /**
+             * Whether the given feature is supported by this institution.
+             */
+            supported: boolean;
+          }
+
+          interface PaymentMethod {
+            /**
+             * Whether the given feature is supported by this institution.
+             */
+            supported: boolean;
+          }
+
+          interface Transactions {
+            /**
+             * Whether the given feature is supported by this institution.
+             */
+            supported: boolean;
+          }
+        }
+
+        type Status = 'active' | 'degraded' | 'inactive';
+      }
+    }
+  }
+}

package/types/FinancialConnections/InstitutionsResource.d.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      interface InstitutionRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface InstitutionListParams extends PaginationParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class InstitutionsResource {
+        /**
+         * Retrieves the details of a Financial Connections Institution.
+         */
+        retrieve(
+          id: string,
+          params?: InstitutionRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.FinancialConnections.Institution>>;
+
+        /**
+         * Returns a list of Financial Connections Institution objects.
+         */
+        list(
+          params?: InstitutionListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.Institution>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.Institution>;
+      }
+    }
+  }
+}

package/types/FinancialConnections/Sessions.d.ts

@@ -34,11 +34,15 @@ declare module 'stripe' {
 
         filters?: Session.Filters;
 
+        limits?: Session.Limits;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
         livemode: boolean;
 
+        manual_entry?: Session.ManualEntry;
+
         /**
          * Permissions requested for accounts collected during this session.
          */
@@ -53,6 +57,13 @@ declare module 'stripe' {
          * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
          */
         return_url?: string;
+
+        /**
+         * The current state of the session.
+         */
+        status?: Session.Status;
+
+        status_details?: Session.StatusDetails;
       }
 
       namespace Session {
@@ -87,6 +98,11 @@ declare module 'stripe' {
            * List of countries from which to filter accounts.
            */
           countries: Array<string> | null;
+
+          /**
+           * Stripe ID of the institution with which the customer should be directed to log in.
+           */
+          institution?: string;
         }
 
         namespace Filters {
@@ -98,13 +114,45 @@ declare module 'stripe' {
             | 'savings';
         }
 
+        interface Limits {
+          /**
+           * The number of accounts that can be linked in this Session.
+           */
+          accounts: number;
+        }
+
+        interface ManualEntry {}
+
         type Permission =
           | 'balances'
           | 'ownership'
           | 'payment_method'
           | 'transactions';
 
-        type Prefetch = 'balances' | 'ownership' | 'transactions';
+        type Prefetch =
+          | 'balances'
+          | 'inferred_balances'
+          | 'ownership'
+          | 'transactions';
+
+        type Status = 'cancelled' | 'failed' | 'pending' | 'succeeded';
+
+        interface StatusDetails {
+          cancelled?: StatusDetails.Cancelled;
+        }
+
+        namespace StatusDetails {
+          interface Cancelled {
+            /**
+             * The reason for the Session being cancelled.
+             */
+            reason: Cancelled.Reason;
+          }
+
+          namespace Cancelled {
+            type Reason = 'custom_manual_entry' | 'other';
+          }
+        }
       }
     }
   }

package/types/FinancialConnections/SessionsResource.d.ts

@@ -26,6 +26,16 @@ declare module 'stripe' {
          */
         filters?: SessionCreateParams.Filters;
 
+        /**
+         * Settings for configuring Session-specific limits.
+         */
+        limits?: SessionCreateParams.Limits;
+
+        /**
+         * Settings for configuring manual entry of account details for this Session.
+         */
+        manual_entry?: SessionCreateParams.ManualEntry;
+
         /**
          * List of data features that you would like to retrieve upon account creation.
          */
@@ -69,6 +79,11 @@ declare module 'stripe' {
            * List of countries from which to collect accounts.
            */
           countries?: Array<string>;
+
+          /**
+           * Stripe ID of the institution with which the customer should be directed to log in.
+           */
+          institution?: string;
         }
 
         namespace Filters {
@@ -80,13 +95,35 @@ declare module 'stripe' {
             | 'savings';
         }
 
+        interface Limits {
+          /**
+           * The number of accounts that can be linked in this Session.
+           */
+          accounts: number;
+        }
+
+        interface ManualEntry {
+          /**
+           * Whether manual entry will be handled by Stripe during the Session.
+           */
+          mode?: ManualEntry.Mode;
+        }
+
+        namespace ManualEntry {
+          type Mode = 'automatic' | 'custom';
+        }
+
         type Permission =
           | 'balances'
           | 'ownership'
           | 'payment_method'
           | 'transactions';
 
-        type Prefetch = 'balances' | 'ownership' | 'transactions';
+        type Prefetch =
+          | 'balances'
+          | 'inferred_balances'
+          | 'ownership'
+          | 'transactions';
       }
 
       interface SessionRetrieveParams {