stripe 18.3.0 → 18.4.0-beta.2

package/types/FinancialConnections/Institutions.d.ts

@@ -0,0 +1,98 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * An institution represents a financial institution to which an end user can connect using 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';
+
+        /**
+         * The list of countries supported by this institution, formatted as ISO country codes.
+         */
+        countries: Array<string>;
+
+        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. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
+         */
+        routing_numbers: Array<string>;
+
+        /**
+         * The status of this institution in the Financial Connections authentication flow.
+         */
+        status: Institution.Status;
+
+        /**
+         * A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
+         */
+        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 {
@@ -67,6 +78,8 @@ declare module 'stripe' {
            */
           customer?: string | Stripe.Customer;
 
+          customer_account?: string;
+
           /**
            * Type of account holder that this account belongs to.
            */
@@ -87,6 +100,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 +116,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;
+
+        /**
+         * Customize manual entry behavior
+         */
+        manual_entry?: SessionCreateParams.ManualEntry;
+
         /**
          * List of data features that you would like to retrieve upon account creation.
          */
@@ -49,6 +59,11 @@ declare module 'stripe' {
            */
           customer?: string;
 
+          /**
+           * The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.
+           */
+          customer_account?: string;
+
           /**
            * Type of account holder to collect accounts for.
            */
@@ -69,6 +84,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 +100,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 {

package/types/FxQuotes.d.ts

@@ -0,0 +1,153 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The FX Quotes API provides three key functions:
+     * - View current exchange rates: The object shows Stripe's current exchange rate for any given currency pair.
+     * - Extended quotes: The API provides rate quotes valid for a 1-hour period or a 24-hour period, eliminating uncertainty from FX fluctuations.
+     * - View FX fees: The API provides information on the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.
+     */
+    interface FxQuote {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'fx_quote';
+
+      /**
+       * Time at which the quote was created, measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won't be usable for any transactions.
+       */
+      lock_duration: FxQuote.LockDuration;
+
+      /**
+       * Time at which the quote will expire, measured in seconds since the Unix epoch.
+       *
+       * If lock_duration is set to ‘none' this field will be set to null.
+       */
+      lock_expires_at: number | null;
+
+      /**
+       * Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.
+       *
+       * Can return value none, active, or expired.
+       */
+      lock_status: FxQuote.LockStatus;
+
+      /**
+       * Information about the rates.
+       */
+      rates: {
+        [key: string]: FxQuote.Rates;
+      };
+
+      /**
+       * The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.
+       */
+      to_currency: string;
+
+      usage: FxQuote.Usage;
+    }
+
+    namespace FxQuote {
+      type LockDuration = 'day' | 'five_minutes' | 'hour' | 'none';
+
+      type LockStatus = 'active' | 'expired' | 'none';
+
+      interface Rates {
+        /**
+         * The rate that includes the FX fee rate.
+         */
+        exchange_rate: number;
+
+        rate_details: Rates.RateDetails;
+      }
+
+      namespace Rates {
+        interface RateDetails {
+          /**
+           * The rate for the currency pair.
+           */
+          base_rate: number;
+
+          /**
+           * The fee for locking the conversion rates.
+           */
+          duration_premium: number;
+
+          /**
+           * The FX fee for the currency pair.
+           */
+          fx_fee_rate: number;
+
+          /**
+           * A reference rate for the currency pair provided by the reference rate provider.
+           */
+          reference_rate: number | null;
+
+          /**
+           * The reference rate provider.
+           */
+          reference_rate_provider: 'ecb' | null;
+        }
+      }
+
+      interface Usage {
+        /**
+         * The details required to use an FX Quote for a payment
+         */
+        payment: Usage.Payment | null;
+
+        /**
+         * The details required to use an FX Quote for a transfer
+         */
+        transfer: Usage.Transfer | null;
+
+        /**
+         * The transaction type for which the FX Quote will be used.
+         *
+         * Can be 'payment' or 'transfer'.
+         */
+        type: Usage.Type;
+      }
+
+      namespace Usage {
+        interface Payment {
+          /**
+           * The Stripe account ID that the funds will be transferred to.
+           *
+           * This field should match the account ID that would be used in the PaymentIntent's transfer_data[destination] field.
+           */
+          destination: string | null;
+
+          /**
+           * The Stripe account ID that these funds are intended for.
+           *
+           * This field must match the account ID that would be used in the PaymentIntent's on_behalf_of field.
+           */
+          on_behalf_of: string | null;
+        }
+
+        interface Transfer {
+          /**
+           * The Stripe account ID that the funds will be transferred to.
+           *
+           * This field should match the account ID that would be used in the Transfer's destination field.
+           */
+          destination: string;
+        }
+
+        type Type = 'payment' | 'transfer';
+      }
+    }
+  }
+}

package/types/FxQuotesResource.d.ts

@@ -0,0 +1,130 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface FxQuoteCreateParams {
+      /**
+       * A list of three letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be [supported currencies](https://stripe.com/docs/currencies).
+       */
+      from_currencies: Array<string>;
+
+      /**
+       * The duration that you wish the quote to be locked for. The quote will be usable for the duration specified. The default is `none`. The maximum is 1 day.
+       */
+      lock_duration: FxQuoteCreateParams.LockDuration;
+
+      /**
+       * 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).
+       */
+      to_currency: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * The usage specific information for the quote.
+       */
+      usage?: FxQuoteCreateParams.Usage;
+    }
+
+    namespace FxQuoteCreateParams {
+      type LockDuration = 'day' | 'five_minutes' | 'hour' | 'none';
+
+      interface Usage {
+        /**
+         * The payment transaction details that are intended for the FX Quote.
+         */
+        payment?: Usage.Payment;
+
+        /**
+         * The transfer transaction details that are intended for the FX Quote.
+         */
+        transfer?: Usage.Transfer;
+
+        /**
+         * Which transaction the FX Quote will be used for
+         *
+         * Can be “payment” | “transfer”
+         */
+        type: Usage.Type;
+      }
+
+      namespace Usage {
+        interface Payment {
+          /**
+           * The Stripe account ID that the funds will be transferred to.
+           *
+           * This field should match the account ID that would be used in the PaymentIntent's transfer_data[destination] field.
+           */
+          destination?: string;
+
+          /**
+           * The Stripe account ID that these funds are intended for.
+           *
+           * This field should match the account ID that would be used in the PaymentIntent's on_behalf_of field.
+           */
+          on_behalf_of?: string;
+        }
+
+        interface Transfer {
+          /**
+           * The Stripe account ID that the funds will be transferred to.
+           *
+           * This field should match the account ID that would be used in the Transfer's destination field.
+           */
+          destination: string;
+        }
+
+        type Type = 'payment' | 'transfer';
+      }
+    }
+
+    interface FxQuoteRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface FxQuoteListParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class FxQuotesResource {
+      /**
+       * Creates an FX Quote object
+       */
+      create(
+        params: FxQuoteCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FxQuote>>;
+
+      /**
+       * Retrieve an FX Quote object
+       */
+      retrieve(
+        id: string,
+        params?: FxQuoteRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FxQuote>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FxQuote>>;
+
+      /**
+       * Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
+       */
+      list(
+        params?: FxQuoteListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.FxQuote>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.FxQuote>;
+    }
+  }
+}

package/types/Identity/VerificationSessions.d.ts

@@ -85,6 +85,11 @@ declare module 'stripe' {
          */
         related_customer: string | null;
 
+        /**
+         * Token referencing a Customer Account resource.
+         */
+        related_customer_account?: string | null;
+
         related_person?: VerificationSession.RelatedPerson;
 
         /**

package/types/Identity/VerificationSessionsResource.d.ts

@@ -34,6 +34,11 @@ declare module 'stripe' {
          */
         related_customer?: string;
 
+        /**
+         * Token referencing a Customer Account resource.
+         */
+        related_customer_account?: string;
+
         /**
          * Tokens referencing a Person resource and it's associated account.
          */
@@ -221,6 +226,8 @@ declare module 'stripe' {
 
         related_customer?: string;
 
+        related_customer_account?: string;
+
         /**
          * Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
          */

package/types/InvoiceItems.d.ts

@@ -58,6 +58,11 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
+      /**
+       * The ID of the account who will be billed when this invoice item is billed.
+       */
+      customer_account?: string | null;
+
       /**
        * Time at which the object was created. Measured in seconds since the Unix epoch.
        */
@@ -93,6 +98,11 @@ declare module 'stripe' {
        */
       livemode: boolean;
 
+      /**
+       * The margins which apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+       */
+      margins?: Array<string | Stripe.Margin> | 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.
        */