stripe 17.3.1 → 17.4.0-beta.2

package/types/Checkout/Sessions.d.ts

@@ -30,6 +30,11 @@ declare module 'stripe' {
          */
         object: 'checkout.session';
 
+        /**
+         * Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
+         */
+        adaptive_pricing: Session.AdaptivePricing | null;
+
         /**
          * When set, provides configuration for actions to take if this Checkout Session expires.
          */
@@ -70,10 +75,15 @@ declare module 'stripe' {
         client_reference_id: string | null;
 
         /**
-         * Client secret to be used when initializing Stripe.js embedded checkout.
+         * The client secret of the Session. Use this with [initCustomCheckout](https://stripe.com/docs/js/custom_checkout/init) on your front end.
          */
         client_secret: string | null;
 
+        /**
+         * Information about the customer collected within the Checkout Session.
+         */
+        collected_information?: Session.CollectedInformation | null;
+
         /**
          * Results of `consent_collection` for this session.
          */
@@ -211,6 +221,13 @@ declare module 'stripe' {
          */
         payment_status: Session.PaymentStatus;
 
+        /**
+         * This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
+         *
+         * For specific permissions, please refer to their dedicated subsections, such as `permissions.update.shipping_details`.
+         */
+        permissions?: Session.Permissions | null;
+
         phone_number_collection?: Session.PhoneNumberCollection;
 
         /**
@@ -224,7 +241,7 @@ declare module 'stripe' {
         redirect_on_completion?: Session.RedirectOnCompletion;
 
         /**
-         * Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
+         * Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
          */
         return_url?: string;
 
@@ -301,6 +318,13 @@ declare module 'stripe' {
       }
 
       namespace Session {
+        interface AdaptivePricing {
+          /**
+           * Whether Adaptive Pricing is enabled.
+           */
+          enabled: boolean;
+        }
+
         interface AfterExpiration {
           /**
            * When set, configuration used to recover the Checkout Session on expiry.
@@ -373,6 +397,157 @@ declare module 'stripe' {
 
         type BillingAddressCollection = 'auto' | 'required';
 
+        interface CollectedInformation {
+          /**
+           * Customer's business name for this Checkout Session
+           */
+          business_name: string | null;
+
+          /**
+           * Customer's email for this Checkout Session
+           */
+          email: string | null;
+
+          /**
+           * Customer's phone number for this Checkout Session
+           */
+          phone: string | null;
+
+          /**
+           * Shipping information for this Checkout Session.
+           */
+          shipping_details: CollectedInformation.ShippingDetails | null;
+
+          /**
+           * Customer's tax ids for this Checkout Session.
+           */
+          tax_ids: Array<CollectedInformation.TaxId> | null;
+        }
+
+        namespace CollectedInformation {
+          interface ShippingDetails {
+            address?: Stripe.Address;
+
+            /**
+             * The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
+             */
+            carrier?: string | null;
+
+            /**
+             * Recipient name.
+             */
+            name?: string;
+
+            /**
+             * Recipient phone (including extension).
+             */
+            phone?: string | null;
+
+            /**
+             * The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
+             */
+            tracking_number?: string | null;
+          }
+
+          interface TaxId {
+            /**
+             * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`
+             */
+            type: TaxId.Type;
+
+            /**
+             * The value of the tax ID.
+             */
+            value: string | null;
+          }
+
+          namespace TaxId {
+            type Type =
+              | 'ad_nrt'
+              | 'ae_trn'
+              | 'ar_cuit'
+              | 'au_abn'
+              | 'au_arn'
+              | 'bg_uic'
+              | 'bh_vat'
+              | 'bo_tin'
+              | 'br_cnpj'
+              | 'br_cpf'
+              | 'by_tin'
+              | 'ca_bn'
+              | 'ca_gst_hst'
+              | 'ca_pst_bc'
+              | 'ca_pst_mb'
+              | 'ca_pst_sk'
+              | 'ca_qst'
+              | 'ch_uid'
+              | 'ch_vat'
+              | 'cl_tin'
+              | 'cn_tin'
+              | 'co_nit'
+              | 'cr_tin'
+              | 'de_stn'
+              | 'do_rcn'
+              | 'ec_ruc'
+              | 'eg_tin'
+              | 'es_cif'
+              | 'eu_oss_vat'
+              | 'eu_vat'
+              | 'gb_vat'
+              | 'ge_vat'
+              | 'hk_br'
+              | 'hr_oib'
+              | 'hu_tin'
+              | 'id_npwp'
+              | 'il_vat'
+              | 'in_gst'
+              | 'is_vat'
+              | 'jp_cn'
+              | 'jp_rn'
+              | 'jp_trn'
+              | 'ke_pin'
+              | 'kr_brn'
+              | 'kz_bin'
+              | 'li_uid'
+              | 'li_vat'
+              | 'ma_vat'
+              | 'md_vat'
+              | 'mx_rfc'
+              | 'my_frp'
+              | 'my_itn'
+              | 'my_sst'
+              | 'ng_tin'
+              | 'no_vat'
+              | 'no_voec'
+              | 'nz_gst'
+              | 'om_vat'
+              | 'pe_ruc'
+              | 'ph_tin'
+              | 'ro_tin'
+              | 'rs_pib'
+              | 'ru_inn'
+              | 'ru_kpp'
+              | 'sa_vat'
+              | 'sg_gst'
+              | 'sg_uen'
+              | 'si_tin'
+              | 'sv_nit'
+              | 'th_vat'
+              | 'tr_tin'
+              | 'tw_vat'
+              | 'tz_vat'
+              | 'ua_vat'
+              | 'unknown'
+              | 'us_ein'
+              | 'uy_ruc'
+              | 'uz_tin'
+              | 'uz_vat'
+              | 've_rif'
+              | 'vn_tin'
+              | 'za_vat';
+          }
+        }
+
         interface Consent {
           /**
            * If `opt_in`, the customer consents to receiving promotional communications
@@ -490,7 +665,7 @@ declare module 'stripe' {
 
           interface TaxId {
             /**
-             * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`
+             * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`
              */
             type: TaxId.Type;
 
@@ -548,6 +723,7 @@ declare module 'stripe' {
               | 'kr_brn'
               | 'kz_bin'
               | 'li_uid'
+              | 'li_vat'
               | 'ma_vat'
               | 'md_vat'
               | 'mx_rfc'
@@ -961,6 +1137,8 @@ declare module 'stripe' {
 
           paypal?: PaymentMethodOptions.Paypal;
 
+          payto?: PaymentMethodOptions.Payto;
+
           pix?: PaymentMethodOptions.Pix;
 
           revolut_pay?: PaymentMethodOptions.RevolutPay;
@@ -1115,6 +1293,8 @@ declare module 'stripe' {
           }
 
           interface BacsDebit {
+            mandate_options?: BacsDebit.MandateOptions;
+
             /**
              * Indicates that you intend to make future payments with this PaymentIntent's payment method.
              *
@@ -1128,6 +1308,8 @@ declare module 'stripe' {
           }
 
           namespace BacsDebit {
+            interface MandateOptions {}
+
             type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
           }
 
@@ -1169,6 +1351,31 @@ declare module 'stripe' {
           interface Card {
             installments?: Card.Installments;
 
+            /**
+             * Request ability to [capture beyond the standard authorization validity window](https://stripe.com/payments/extended-authorization) for this CheckoutSession.
+             */
+            request_decremental_authorization?: Card.RequestDecrementalAuthorization;
+
+            /**
+             * Request ability to [capture beyond the standard authorization validity window](https://stripe.com/payments/extended-authorization) for this CheckoutSession.
+             */
+            request_extended_authorization?: Card.RequestExtendedAuthorization;
+
+            /**
+             * Request ability to [increment the authorization](https://stripe.com/payments/incremental-authorization) for this CheckoutSession.
+             */
+            request_incremental_authorization?: Card.RequestIncrementalAuthorization;
+
+            /**
+             * Request ability to make [multiple captures](https://stripe.com/payments/multicapture) for this CheckoutSession.
+             */
+            request_multicapture?: Card.RequestMulticapture;
+
+            /**
+             * Request ability to [overcapture](https://stripe.com/payments/overcapture) for this CheckoutSession.
+             */
+            request_overcapture?: Card.RequestOvercapture;
+
             /**
              * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
              */
@@ -1204,6 +1411,16 @@ declare module 'stripe' {
               enabled?: boolean;
             }
 
+            type RequestDecrementalAuthorization = 'if_available' | 'never';
+
+            type RequestExtendedAuthorization = 'if_available' | 'never';
+
+            type RequestIncrementalAuthorization = 'if_available' | 'never';
+
+            type RequestMulticapture = 'if_available' | 'never';
+
+            type RequestOvercapture = 'if_available' | 'never';
+
             type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
 
             type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
@@ -1562,12 +1779,100 @@ declare module 'stripe' {
              * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://stripe.com/strong-customer-authentication).
              */
             setup_future_usage?: Paypal.SetupFutureUsage;
+
+            /**
+             * The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
+             */
+            subsellers?: Array<string>;
           }
 
           namespace Paypal {
             type SetupFutureUsage = 'none' | 'off_session';
           }
 
+          interface Payto {
+            mandate_options?: Payto.MandateOptions;
+
+            /**
+             * Indicates that you intend to make future payments with this PaymentIntent's payment method.
+             *
+             * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
+             *
+             * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
+             *
+             * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://stripe.com/strong-customer-authentication).
+             */
+            setup_future_usage?: Payto.SetupFutureUsage;
+          }
+
+          namespace Payto {
+            interface MandateOptions {
+              /**
+               * Amount that will be collected. It is required when `amount_type` is `fixed`.
+               */
+              amount: number | null;
+
+              /**
+               * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
+               */
+              amount_type: MandateOptions.AmountType | null;
+
+              /**
+               * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+               */
+              end_date: string | null;
+
+              /**
+               * The periodicity at which payments will be collected.
+               */
+              payment_schedule: MandateOptions.PaymentSchedule | null;
+
+              /**
+               * The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
+               */
+              payments_per_period: number | null;
+
+              /**
+               * The purpose for which payments are made. Defaults to retail.
+               */
+              purpose: MandateOptions.Purpose | null;
+
+              /**
+               * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+               */
+              start_date: string | null;
+            }
+
+            namespace MandateOptions {
+              type AmountType = 'fixed' | 'maximum';
+
+              type PaymentSchedule =
+                | 'adhoc'
+                | 'annual'
+                | 'daily'
+                | 'fortnightly'
+                | 'monthly'
+                | 'quarterly'
+                | 'semi_annual'
+                | 'weekly';
+
+              type Purpose =
+                | 'dependant_support'
+                | 'government'
+                | 'loan'
+                | 'mortgage'
+                | 'other'
+                | 'pension'
+                | 'personal'
+                | 'retail'
+                | 'salary'
+                | 'tax'
+                | 'utility';
+            }
+
+            type SetupFutureUsage = 'none' | 'off_session';
+          }
+
           interface Pix {
             /**
              * The number of seconds after which Pix payment will expire.
@@ -1600,6 +1905,8 @@ declare module 'stripe' {
           }
 
           interface SepaDebit {
+            mandate_options?: SepaDebit.MandateOptions;
+
             /**
              * Indicates that you intend to make future payments with this PaymentIntent's payment method.
              *
@@ -1613,6 +1920,8 @@ declare module 'stripe' {
           }
 
           namespace SepaDebit {
+            interface MandateOptions {}
+
             type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
           }
 
@@ -1660,6 +1969,8 @@ declare module 'stripe' {
             interface FinancialConnections {
               filters?: FinancialConnections.Filters;
 
+              manual_entry?: FinancialConnections.ManualEntry;
+
               /**
                * The list of permissions to request. The `payment_method` permission must be included.
                */
@@ -1682,19 +1993,39 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
+
+                /**
+                 * The institution to use to filter for possible accounts to link.
+                 */
+                institution?: string;
               }
 
               namespace Filters {
                 type AccountSubcategory = 'checking' | 'savings';
               }
 
+              interface ManualEntry {
+                /**
+                 * Settings for configuring manual entry of account details.
+                 */
+                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';
             }
 
             type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
@@ -1705,6 +2036,30 @@ declare module 'stripe' {
 
         type PaymentStatus = 'no_payment_required' | 'paid' | 'unpaid';
 
+        interface Permissions {
+          /**
+           * Permissions for updating the Checkout Session.
+           */
+          update: Permissions.Update | null;
+        }
+
+        namespace Permissions {
+          interface Update {
+            /**
+             * Determines which entity is allowed to update the shipping details.
+             *
+             * Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
+             *
+             * When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
+             */
+            shipping_details: Update.ShippingDetails | null;
+          }
+
+          namespace Update {
+            type ShippingDetails = 'client_only' | 'server_only';
+          }
+        }
+
         interface PhoneNumberCollection {
           /**
            * Indicates whether phone number collection is enabled for the session
@@ -2211,7 +2566,7 @@ declare module 'stripe' {
           }
         }
 
-        type UiMode = 'embedded' | 'hosted';
+        type UiMode = 'custom' | 'embedded' | 'hosted';
       }
     }
   }