stripe 9.0.0 → 9.3.0

package/types/2020-08-27/SetupIntents.d.ts

@@ -21,6 +21,13 @@ declare module 'stripe' {
        */
       application: string | Stripe.Application | null;
 
+      /**
+       * If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
+       *
+       * It can only be used for this Stripe Account's own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
+       */
+      attach_to_self?: boolean;
+
       /**
        * Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.
        */
@@ -50,6 +57,13 @@ declare module 'stripe' {
        */
       description: string | null;
 
+      /**
+       * Indicates the directions of money movement for which this payment method is intended to be used.
+       *
+       * Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.
+       */
+      flow_directions?: Array<SetupIntent.FlowDirection> | null;
+
       /**
        * The error encountered in the previous SetupIntent confirmation.
        */
@@ -124,6 +138,8 @@ declare module 'stripe' {
         | 'duplicate'
         | 'requested_by_customer';
 
+      type FlowDirection = 'inbound' | 'outbound';
+
       interface LastSetupError {
         /**
          * For card errors, the ID of the failed charge.
@@ -284,6 +300,8 @@ declare module 'stripe' {
 
         card?: PaymentMethodOptions.Card;
 
+        link?: PaymentMethodOptions.Link;
+
         sepa_debit?: PaymentMethodOptions.SepaDebit;
 
         us_bank_account?: PaymentMethodOptions.UsBankAccount;
@@ -419,6 +437,13 @@ declare module 'stripe' {
           type RequestThreeDSecure = 'any' | 'automatic' | 'challenge_only';
         }
 
+        interface Link {
+          /**
+           * Token used for persistent Link logins.
+           */
+          persistent_token: string | null;
+        }
+
         interface SepaDebit {
           mandate_options?: SepaDebit.MandateOptions;
         }
@@ -601,6 +626,11 @@ declare module 'stripe' {
          */
         acss_debit?: PaymentMethodData.AcssDebit;
 
+        /**
+         * If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
+         */
+        affirm?: PaymentMethodData.Affirm;
+
         /**
          * If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
          */
@@ -681,6 +711,11 @@ declare module 'stripe' {
          */
         konbini?: PaymentMethodData.Konbini;
 
+        /**
+         * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
+         */
+        link?: PaymentMethodData.Link;
+
         /**
          * 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          */
@@ -745,6 +780,8 @@ declare module 'stripe' {
           transit_number: string;
         }
 
+        interface Affirm {}
+
         interface AfterpayClearpay {}
 
         interface Alipay {}
@@ -947,6 +984,8 @@ declare module 'stripe' {
 
         interface Konbini {}
 
+        interface Link {}
+
         interface Oxxo {}
 
         interface P24 {
@@ -1007,6 +1046,7 @@ declare module 'stripe' {
 
         type Type =
           | 'acss_debit'
+          | 'affirm'
           | 'afterpay_clearpay'
           | 'alipay'
           | 'au_becs_debit'
@@ -1021,6 +1061,7 @@ declare module 'stripe' {
           | 'ideal'
           | 'klarna'
           | 'konbini'
+          | 'link'
           | 'oxxo'
           | 'p24'
           | 'paynow'
@@ -1076,6 +1117,11 @@ declare module 'stripe' {
          */
         card?: PaymentMethodOptions.Card;
 
+        /**
+         * If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
+         */
+        link?: PaymentMethodOptions.Link;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -1229,6 +1275,13 @@ declare module 'stripe' {
           type RequestThreeDSecure = 'any' | 'automatic';
         }
 
+        interface Link {
+          /**
+           * Token used for persistent Link logins.
+           */
+          persistent_token?: string;
+        }
+
         interface SepaDebit {
           /**
            * Additional fields for Mandate creation
@@ -1246,6 +1299,11 @@ declare module 'stripe' {
            */
           financial_connections?: UsBankAccount.FinancialConnections;
 
+          /**
+           * Additional fields for network related functions
+           */
+          networks?: UsBankAccount.Networks;
+
           /**
            * Verification method for the intent
            */
@@ -1273,6 +1331,17 @@ declare module 'stripe' {
               | 'transactions';
           }
 
+          interface Networks {
+            /**
+             * Triggers validations to run across the selected networks
+             */
+            requested?: Array<Networks.Requested>;
+          }
+
+          namespace Networks {
+            type Requested = 'ach' | 'us_domestic_wire';
+          }
+
           type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
         }
       }
@@ -1356,6 +1425,11 @@ declare module 'stripe' {
          */
         acss_debit?: PaymentMethodData.AcssDebit;
 
+        /**
+         * If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
+         */
+        affirm?: PaymentMethodData.Affirm;
+
         /**
          * If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
          */
@@ -1436,6 +1510,11 @@ declare module 'stripe' {
          */
         konbini?: PaymentMethodData.Konbini;
 
+        /**
+         * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
+         */
+        link?: PaymentMethodData.Link;
+
         /**
          * 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          */
@@ -1500,6 +1579,8 @@ declare module 'stripe' {
           transit_number: string;
         }
 
+        interface Affirm {}
+
         interface AfterpayClearpay {}
 
         interface Alipay {}
@@ -1702,6 +1783,8 @@ declare module 'stripe' {
 
         interface Konbini {}
 
+        interface Link {}
+
         interface Oxxo {}
 
         interface P24 {
@@ -1762,6 +1845,7 @@ declare module 'stripe' {
 
         type Type =
           | 'acss_debit'
+          | 'affirm'
           | 'afterpay_clearpay'
           | 'alipay'
           | 'au_becs_debit'
@@ -1776,6 +1860,7 @@ declare module 'stripe' {
           | 'ideal'
           | 'klarna'
           | 'konbini'
+          | 'link'
           | 'oxxo'
           | 'p24'
           | 'paynow'
@@ -1831,6 +1916,11 @@ declare module 'stripe' {
          */
         card?: PaymentMethodOptions.Card;
 
+        /**
+         * If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
+         */
+        link?: PaymentMethodOptions.Link;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -1984,6 +2074,13 @@ declare module 'stripe' {
           type RequestThreeDSecure = 'any' | 'automatic';
         }
 
+        interface Link {
+          /**
+           * Token used for persistent Link logins.
+           */
+          persistent_token?: string;
+        }
+
         interface SepaDebit {
           /**
            * Additional fields for Mandate creation
@@ -2001,6 +2098,11 @@ declare module 'stripe' {
            */
           financial_connections?: UsBankAccount.FinancialConnections;
 
+          /**
+           * Additional fields for network related functions
+           */
+          networks?: UsBankAccount.Networks;
+
           /**
            * Verification method for the intent
            */
@@ -2028,6 +2130,17 @@ declare module 'stripe' {
               | 'transactions';
           }
 
+          interface Networks {
+            /**
+             * Triggers validations to run across the selected networks
+             */
+            requested?: Array<Networks.Requested>;
+          }
+
+          namespace Networks {
+            type Requested = 'ach' | 'us_domestic_wire';
+          }
+
           type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
         }
       }
@@ -2202,6 +2315,11 @@ declare module 'stripe' {
          */
         acss_debit?: PaymentMethodData.AcssDebit;
 
+        /**
+         * If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
+         */
+        affirm?: PaymentMethodData.Affirm;
+
         /**
          * If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
          */
@@ -2282,6 +2400,11 @@ declare module 'stripe' {
          */
         konbini?: PaymentMethodData.Konbini;
 
+        /**
+         * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
+         */
+        link?: PaymentMethodData.Link;
+
         /**
          * 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
          */
@@ -2346,6 +2469,8 @@ declare module 'stripe' {
           transit_number: string;
         }
 
+        interface Affirm {}
+
         interface AfterpayClearpay {}
 
         interface Alipay {}
@@ -2548,6 +2673,8 @@ declare module 'stripe' {
 
         interface Konbini {}
 
+        interface Link {}
+
         interface Oxxo {}
 
         interface P24 {
@@ -2608,6 +2735,7 @@ declare module 'stripe' {
 
         type Type =
           | 'acss_debit'
+          | 'affirm'
           | 'afterpay_clearpay'
           | 'alipay'
           | 'au_becs_debit'
@@ -2622,6 +2750,7 @@ declare module 'stripe' {
           | 'ideal'
           | 'klarna'
           | 'konbini'
+          | 'link'
           | 'oxxo'
           | 'p24'
           | 'paynow'
@@ -2677,6 +2806,11 @@ declare module 'stripe' {
          */
         card?: PaymentMethodOptions.Card;
 
+        /**
+         * If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
+         */
+        link?: PaymentMethodOptions.Link;
+
         /**
          * If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.
          */
@@ -2830,6 +2964,13 @@ declare module 'stripe' {
           type RequestThreeDSecure = 'any' | 'automatic';
         }
 
+        interface Link {
+          /**
+           * Token used for persistent Link logins.
+           */
+          persistent_token?: string;
+        }
+
         interface SepaDebit {
           /**
            * Additional fields for Mandate creation
@@ -2847,6 +2988,11 @@ declare module 'stripe' {
            */
           financial_connections?: UsBankAccount.FinancialConnections;
 
+          /**
+           * Additional fields for network related functions
+           */
+          networks?: UsBankAccount.Networks;
+
           /**
            * Verification method for the intent
            */
@@ -2874,6 +3020,17 @@ declare module 'stripe' {
               | 'transactions';
           }
 
+          interface Networks {
+            /**
+             * Triggers validations to run across the selected networks
+             */
+            requested?: Array<Networks.Requested>;
+          }
+
+          namespace Networks {
+            type Requested = 'ach' | 'us_domestic_wire';
+          }
+
           type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
         }
       }

package/types/2020-08-27/SubscriptionSchedules.d.ts

@@ -254,6 +254,11 @@ declare module 'stripe' {
          */
         items: Array<Phase.Item>;
 
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
+         */
+        metadata: Stripe.Metadata | null;
+
         /**
          * If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.
          */
@@ -584,6 +589,11 @@ declare module 'stripe' {
          */
         iterations?: number;
 
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+
         /**
          * If a subscription schedule will create prorations when transitioning to this phase. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. See [Prorations](https://stripe.com/docs/billing/subscriptions/prorations).
          */
@@ -999,6 +1009,11 @@ declare module 'stripe' {
          */
         iterations?: number;
 
+        /**
+         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
+         */
+        metadata?: Stripe.MetadataParam;
+
         /**
          * If a subscription schedule will create prorations when transitioning to this phase. Possible values are `create_prorations` or `none`, and the default value is `create_prorations`. See [Prorations](https://stripe.com/docs/billing/subscriptions/prorations).
          */

package/types/2020-08-27/Subscriptions.d.ts

@@ -102,6 +102,11 @@ declare module 'stripe' {
        */
       default_tax_rates?: Array<Stripe.TaxRate> | null;
 
+      /**
+       * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.
+       */
+      description: string | null;
+
       /**
        * Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
        */
@@ -254,6 +259,11 @@ declare module 'stripe' {
          * The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
          */
         payment_method_types: Array<PaymentSettings.PaymentMethodType> | null;
+
+        /**
+         * Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.
+         */
+        save_default_payment_method: PaymentSettings.SaveDefaultPaymentMethod | null;
       }
 
       namespace PaymentSettings {
@@ -419,12 +429,15 @@ declare module 'stripe' {
           | 'grabpay'
           | 'ideal'
           | 'konbini'
+          | 'link'
           | 'paynow'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
           | 'us_bank_account'
           | 'wechat_pay';
+
+        type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
       }
 
       interface PendingInvoiceItemInterval {
@@ -509,7 +522,7 @@ declare module 'stripe' {
       application_fee_percent?: number;
 
       /**
-       * Automatic tax settings for this subscription.
+       * Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
        */
       automatic_tax?: SubscriptionCreateParams.AutomaticTax;
 
@@ -570,6 +583,11 @@ declare module 'stripe' {
        */
       default_tax_rates?: Stripe.Emptyable<Array<string>>;
 
+      /**
+       * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.
+       */
+      description?: string;
+
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -839,6 +857,11 @@ declare module 'stripe' {
         payment_method_types?: Stripe.Emptyable<
           Array<PaymentSettings.PaymentMethodType>
         >;
+
+        /**
+         * Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.
+         */
+        save_default_payment_method?: PaymentSettings.SaveDefaultPaymentMethod;
       }
 
       namespace PaymentSettings {
@@ -1024,12 +1047,15 @@ declare module 'stripe' {
           | 'grabpay'
           | 'ideal'
           | 'konbini'
+          | 'link'
           | 'paynow'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
           | 'us_bank_account'
           | 'wechat_pay';
+
+        type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
       }
 
       interface PendingInvoiceItemInterval {
@@ -1082,7 +1108,7 @@ declare module 'stripe' {
       application_fee_percent?: number;
 
       /**
-       * Automatic tax settings for this subscription.
+       * Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
        */
       automatic_tax?: SubscriptionUpdateParams.AutomaticTax;
 
@@ -1138,6 +1164,11 @@ declare module 'stripe' {
        */
       default_tax_rates?: Stripe.Emptyable<Array<string>>;
 
+      /**
+       * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.
+       */
+      description?: string;
+
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -1449,6 +1480,11 @@ declare module 'stripe' {
         payment_method_types?: Stripe.Emptyable<
           Array<PaymentSettings.PaymentMethodType>
         >;
+
+        /**
+         * Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.
+         */
+        save_default_payment_method?: PaymentSettings.SaveDefaultPaymentMethod;
       }
 
       namespace PaymentSettings {
@@ -1634,12 +1670,15 @@ declare module 'stripe' {
           | 'grabpay'
           | 'ideal'
           | 'konbini'
+          | 'link'
           | 'paynow'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
           | 'us_bank_account'
           | 'wechat_pay';
+
+        type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
       }
 
       interface PendingInvoiceItemInterval {

package/types/2020-08-27/Terminal/Configurations.d.ts

@@ -51,6 +51,8 @@ declare module 'stripe' {
 
           chf?: Tipping.Chf;
 
+          czk?: Tipping.Czk;
+
           dkk?: Tipping.Dkk;
 
           eur?: Tipping.Eur;
@@ -124,6 +126,23 @@ declare module 'stripe' {
             smart_tip_threshold?: number;
           }
 
+          interface Czk {
+            /**
+             * Fixed amounts displayed when collecting a tip
+             */
+            fixed_amounts: Array<number> | null;
+
+            /**
+             * Percentages displayed when collecting a tip
+             */
+            percentages: Array<number> | null;
+
+            /**
+             * Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
+             */
+            smart_tip_threshold?: number;
+          }
+
           interface Dkk {
             /**
              * Fixed amounts displayed when collecting a tip
@@ -369,6 +388,11 @@ declare module 'stripe' {
            */
           chf?: Tipping.Chf;
 
+          /**
+           * Tipping configuration for CZK
+           */
+          czk?: Tipping.Czk;
+
           /**
            * Tipping configuration for DKK
            */
@@ -472,6 +496,23 @@ declare module 'stripe' {
             smart_tip_threshold?: number;
           }
 
+          interface Czk {
+            /**
+             * Fixed amounts displayed when collecting a tip
+             */
+            fixed_amounts?: Array<number>;
+
+            /**
+             * Percentages displayed when collecting a tip
+             */
+            percentages?: Array<number>;
+
+            /**
+             * Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
+             */
+            smart_tip_threshold?: number;
+          }
+
           interface Dkk {
             /**
              * Fixed amounts displayed when collecting a tip
@@ -708,6 +749,11 @@ declare module 'stripe' {
            */
           chf?: Tipping.Chf;
 
+          /**
+           * Tipping configuration for CZK
+           */
+          czk?: Tipping.Czk;
+
           /**
            * Tipping configuration for DKK
            */
@@ -811,6 +857,23 @@ declare module 'stripe' {
             smart_tip_threshold?: number;
           }
 
+          interface Czk {
+            /**
+             * Fixed amounts displayed when collecting a tip
+             */
+            fixed_amounts?: Array<number>;
+
+            /**
+             * Percentages displayed when collecting a tip
+             */
+            percentages?: Array<number>;
+
+            /**
+             * Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
+             */
+            smart_tip_threshold?: number;
+          }
+
           interface Dkk {
             /**
              * Fixed amounts displayed when collecting a tip