stripe 18.0.0 → 18.1.0-beta.1

package/types/Checkout/SessionsResource.d.ts

@@ -76,6 +76,11 @@ declare module 'stripe' {
          */
         customer?: string;
 
+        /**
+         * ID of an existing Account, if one exists. Has the same behavior as `customer`.
+         */
+        customer_account?: string;
+
         /**
          * Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
          *
@@ -699,6 +704,11 @@ declare module 'stripe' {
            */
           dynamic_tax_rates?: Array<string>;
 
+          /**
+           * 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`.
+           */
+          metadata?: Stripe.MetadataParam;
+
           /**
            * The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object. One of `price` or `price_data` is required.
            */
@@ -1207,6 +1217,11 @@ declare module 'stripe' {
            */
           paypal?: PaymentMethodOptions.Paypal;
 
+          /**
+           * contains details about the PayTo payment method options.
+           */
+          payto?: PaymentMethodOptions.Payto;
+
           /**
            * contains details about the Pix payment method options.
            */
@@ -1476,6 +1491,11 @@ declare module 'stripe' {
              */
             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.
              */
@@ -1537,6 +1557,8 @@ declare module 'stripe' {
               enabled?: boolean;
             }
 
+            type RequestDecrementalAuthorization = 'if_available' | 'never';
+
             type RequestExtendedAuthorization = 'if_available' | 'never';
 
             type RequestIncrementalAuthorization = 'if_available' | 'never';
@@ -1932,6 +1954,11 @@ declare module 'stripe' {
              */
             reference?: string;
 
+            /**
+             * A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
+             */
+            reference_id?: string;
+
             /**
              * The risk correlation ID for an on-session payment using a saved PayPal payment method.
              */
@@ -1949,6 +1976,11 @@ declare module 'stripe' {
              * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
              */
             setup_future_usage?: Stripe.Emptyable<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 {
@@ -1978,6 +2010,92 @@ declare module 'stripe' {
             type SetupFutureUsage = 'none' | 'off_session';
           }
 
+          interface Payto {
+            /**
+             * Additional fields for Mandate creation
+             */
+            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;
+
+              /**
+               * 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;
+
+              /**
+               * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+               */
+              end_date?: string;
+
+              /**
+               * The periodicity at which payments will be collected.
+               */
+              payment_schedule?: MandateOptions.PaymentSchedule;
+
+              /**
+               * 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;
+
+              /**
+               * The purpose for which payments are made. Defaults to retail.
+               */
+              purpose?: MandateOptions.Purpose;
+
+              /**
+               * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+               */
+              start_date?: string;
+            }
+
+            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 (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
@@ -2111,7 +2229,11 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch = 'balances' | 'ownership' | 'transactions';
+              type Prefetch =
+                | 'balances'
+                | 'inferred_balances'
+                | 'ownership'
+                | 'transactions';
             }
 
             type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
@@ -2166,6 +2288,7 @@ declare module 'stripe' {
           | 'eps'
           | 'fpx'
           | 'giropay'
+          | 'gopay'
           | 'grabpay'
           | 'ideal'
           | 'kakao_pay'
@@ -2173,6 +2296,7 @@ declare module 'stripe' {
           | 'konbini'
           | 'kr_card'
           | 'link'
+          | 'mb_way'
           | 'mobilepay'
           | 'multibanco'
           | 'naver_pay'
@@ -2182,12 +2306,16 @@ declare module 'stripe' {
           | 'payco'
           | 'paynow'
           | 'paypal'
+          | 'payto'
           | 'pix'
           | 'promptpay'
+          | 'qris'
+          | 'rechnung'
           | 'revolut_pay'
           | 'samsung_pay'
           | 'satispay'
           | 'sepa_debit'
+          | 'shopeepay'
           | 'sofort'
           | 'swish'
           | 'twint'
@@ -2196,6 +2324,20 @@ declare module 'stripe' {
           | 'zip';
 
         interface Permissions {
+          /**
+           * Permissions for updating the Checkout Session.
+           */
+          update?: Permissions.Update;
+
+          /**
+           * Determines which entity is allowed to update the line items.
+           *
+           * Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
+           *
+           * When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
+           */
+          update_line_items?: Permissions.UpdateLineItems;
+
           /**
            * Determines which entity is allowed to update the shipping details.
            *
@@ -2207,6 +2349,34 @@ declare module 'stripe' {
         }
 
         namespace Permissions {
+          interface Update {
+            /**
+             * Determines which entity is allowed to update the line items.
+             *
+             * Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
+             *
+             * When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
+             */
+            line_items?: Update.LineItems;
+
+            /**
+             * 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;
+          }
+
+          namespace Update {
+            type LineItems = 'client_only' | 'server_only';
+
+            type ShippingDetails = 'client_only' | 'server_only';
+          }
+
+          type UpdateLineItems = 'client_only' | 'server_only';
+
           type UpdateShippingDetails = 'client_only' | 'server_only';
         }
 
@@ -2815,6 +2985,23 @@ declare module 'stripe' {
          */
         expand?: Array<string>;
 
+        /**
+         * A list of items the customer is purchasing.
+         *
+         * When updating line items, you must retransmit the entire array of line items.
+         *
+         * To retain an existing line item, specify its `id`.
+         *
+         * To update an existing line item, specify its `id` along with the new values of the fields to update.
+         *
+         * To add a new line item, specify a `price` and `quantity`.
+         *
+         * To remove an existing line item, omit the line item's ID from the retransmitted array.
+         *
+         * To reorder a line item, specify it at the desired position in the retransmitted array.
+         */
+        line_items?: Array<SessionUpdateParams.LineItem>;
+
         /**
          * 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`.
          */
@@ -2884,6 +3071,57 @@ declare module 'stripe' {
           }
         }
 
+        interface LineItem {
+          /**
+           * When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout.
+           */
+          adjustable_quantity?: LineItem.AdjustableQuantity;
+
+          /**
+           * ID of an existing line item.
+           */
+          id?: string;
+
+          /**
+           * 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`.
+           */
+          metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+
+          /**
+           * The ID of the [Price](https://stripe.com/docs/api/prices).
+           */
+          price?: string;
+
+          /**
+           * The quantity of the line item being purchased.
+           */
+          quantity?: number;
+
+          /**
+           * The [tax rates](https://stripe.com/docs/api/tax_rates) which apply to this line item.
+           */
+          tax_rates?: Stripe.Emptyable<Array<string>>;
+        }
+
+        namespace LineItem {
+          interface AdjustableQuantity {
+            /**
+             * Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
+             */
+            enabled: boolean;
+
+            /**
+             * The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
+             */
+            maximum?: number;
+
+            /**
+             * The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
+             */
+            minimum?: number;
+          }
+        }
+
         interface ShippingOption {
           /**
            * The ID of the Shipping Rate to use for this shipping option.
@@ -3034,6 +3272,11 @@ declare module 'stripe' {
          */
         customer?: string;
 
+        /**
+         * Only return the Checkout Sessions for the Account specified.
+         */
+        customer_account?: string;
+
         /**
          * Only return the Checkout Sessions for the Customer details specified.
          */

package/types/ConfirmationTokens.d.ts

@@ -134,6 +134,37 @@ declare module 'stripe' {
            * The `cvc_update` Token collected from the Payment Element.
            */
           cvc_token: string | null;
+
+          /**
+           * Installment configuration for payments.
+           */
+          installments?: Card.Installments;
+        }
+
+        namespace Card {
+          interface Installments {
+            plan?: Installments.Plan;
+          }
+
+          namespace Installments {
+            interface Plan {
+              /**
+               * For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.
+               */
+              count: number | null;
+
+              /**
+               * For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
+               * One of `month`.
+               */
+              interval: 'month' | null;
+
+              /**
+               * Type of installment plan, one of `fixed_count`.
+               */
+              type: 'fixed_count';
+            }
+          }
         }
       }
 
@@ -180,6 +211,8 @@ declare module 'stripe' {
          */
         customer: string | Stripe.Customer | null;
 
+        customer_account?: string | null;
+
         customer_balance?: PaymentMethodPreview.CustomerBalance;
 
         eps?: PaymentMethodPreview.Eps;
@@ -188,8 +221,12 @@ declare module 'stripe' {
 
         giropay?: PaymentMethodPreview.Giropay;
 
+        gopay?: PaymentMethodPreview.Gopay;
+
         grabpay?: PaymentMethodPreview.Grabpay;
 
+        id_bank_transfer?: PaymentMethodPreview.IdBankTransfer;
+
         ideal?: PaymentMethodPreview.Ideal;
 
         interac_present?: PaymentMethodPreview.InteracPresent;
@@ -204,6 +241,8 @@ declare module 'stripe' {
 
         link?: PaymentMethodPreview.Link;
 
+        mb_way?: PaymentMethodPreview.MbWay;
+
         mobilepay?: PaymentMethodPreview.Mobilepay;
 
         multibanco?: PaymentMethodPreview.Multibanco;
@@ -224,10 +263,16 @@ declare module 'stripe' {
 
         paypal?: PaymentMethodPreview.Paypal;
 
+        payto?: PaymentMethodPreview.Payto;
+
         pix?: PaymentMethodPreview.Pix;
 
         promptpay?: PaymentMethodPreview.Promptpay;
 
+        qris?: PaymentMethodPreview.Qris;
+
+        rechnung?: PaymentMethodPreview.Rechnung;
+
         revolut_pay?: PaymentMethodPreview.RevolutPay;
 
         samsung_pay?: PaymentMethodPreview.SamsungPay;
@@ -236,8 +281,12 @@ declare module 'stripe' {
 
         sepa_debit?: PaymentMethodPreview.SepaDebit;
 
+        shopeepay?: PaymentMethodPreview.Shopeepay;
+
         sofort?: PaymentMethodPreview.Sofort;
 
+        stripe_balance?: PaymentMethodPreview.StripeBalance;
+
         swish?: PaymentMethodPreview.Swish;
 
         twint?: PaymentMethodPreview.Twint;
@@ -1055,8 +1104,24 @@ declare module 'stripe' {
 
         interface Giropay {}
 
+        interface Gopay {}
+
         interface Grabpay {}
 
+        interface IdBankTransfer {
+          bank: IdBankTransfer.Bank | null;
+
+          bank_code: string | null;
+
+          bank_name: string | null;
+
+          display_name: string | null;
+        }
+
+        namespace IdBankTransfer {
+          type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+        }
+
         interface Ideal {
           /**
            * The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -1284,6 +1349,8 @@ declare module 'stripe' {
           persistent_token?: string;
         }
 
+        interface MbWay {}
+
         interface Mobilepay {}
 
         interface Multibanco {}
@@ -1387,6 +1454,11 @@ declare module 'stripe' {
            */
           country: string | null;
 
+          /**
+           * Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+           */
+          fingerprint?: string | null;
+
           /**
            * Owner's email. Values are provided by PayPal directly
            * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
@@ -1397,12 +1469,60 @@ declare module 'stripe' {
            * PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
            */
           payer_id: string | null;
+
+          /**
+           * Owner's verified email. Values are verified or provided by PayPal directly
+           * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+           */
+          verified_email?: string | null;
+        }
+
+        interface Payto {
+          /**
+           * Bank-State-Branch number of the bank account.
+           */
+          bsb_number: string | null;
+
+          /**
+           * Last four digits of the bank account number.
+           */
+          last4: string | null;
+
+          /**
+           * The PayID alias for the bank account.
+           */
+          pay_id: string | null;
         }
 
         interface Pix {}
 
         interface Promptpay {}
 
+        interface Qris {}
+
+        interface Rechnung {
+          dob?: Rechnung.Dob;
+        }
+
+        namespace Rechnung {
+          interface Dob {
+            /**
+             * The day of birth, between 1 and 31.
+             */
+            day: number;
+
+            /**
+             * The month of birth, between 1 and 12.
+             */
+            month: number;
+
+            /**
+             * The four-digit year of birth.
+             */
+            year: number;
+          }
+        }
+
         interface RevolutPay {}
 
         interface SamsungPay {}
@@ -1455,6 +1575,8 @@ declare module 'stripe' {
           }
         }
 
+        interface Shopeepay {}
+
         interface Sofort {
           /**
            * Two-letter ISO code representing the country the bank account is located in.
@@ -1462,6 +1584,22 @@ declare module 'stripe' {
           country: string | null;
         }
 
+        interface StripeBalance {
+          /**
+           * The connected account ID whose Stripe balance to use as the source of payment
+           */
+          account?: string | null;
+
+          /**
+           * The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
+           */
+          source_type: StripeBalance.SourceType;
+        }
+
+        namespace StripeBalance {
+          type SourceType = 'bank_account' | 'card' | 'fpx';
+        }
+
         interface Swish {}
 
         interface Twint {}
@@ -1486,7 +1624,9 @@ declare module 'stripe' {
           | 'eps'
           | 'fpx'
           | 'giropay'
+          | 'gopay'
           | 'grabpay'
+          | 'id_bank_transfer'
           | 'ideal'
           | 'interac_present'
           | 'kakao_pay'
@@ -1494,6 +1634,7 @@ declare module 'stripe' {
           | 'konbini'
           | 'kr_card'
           | 'link'
+          | 'mb_way'
           | 'mobilepay'
           | 'multibanco'
           | 'naver_pay'
@@ -1504,13 +1645,18 @@ declare module 'stripe' {
           | 'payco'
           | 'paynow'
           | 'paypal'
+          | 'payto'
           | 'pix'
           | 'promptpay'
+          | 'qris'
+          | 'rechnung'
           | 'revolut_pay'
           | 'samsung_pay'
           | 'satispay'
           | 'sepa_debit'
+          | 'shopeepay'
           | 'sofort'
+          | 'stripe_balance'
           | 'swish'
           | 'twint'
           | 'us_bank_account'
@@ -1523,6 +1669,11 @@ declare module 'stripe' {
            */
           account_holder_type: UsBankAccount.AccountHolderType | null;
 
+          /**
+           * Account number of the bank account.
+           */
+          account_number?: string | null;
+
           /**
            * Account type: checkings or savings. Defaults to checking if omitted.
            */

package/types/Coupons.d.ts

@@ -48,7 +48,7 @@ declare module 'stripe' {
       deleted?: void;
 
       /**
-       * One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount.
+       * One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.
        */
       duration: Coupon.Duration;
 

package/types/CreditNoteLineItems.d.ts

@@ -56,6 +56,11 @@ declare module 'stripe' {
        */
       quantity: number | null;
 
+      /**
+       * The tax calculation identifiers of the line item.
+       */
+      tax_calculation_reference?: CreditNoteLineItem.TaxCalculationReference | null;
+
       /**
        * The tax rates which apply to the line item.
        */
@@ -181,6 +186,18 @@ declare module 'stripe' {
         }
       }
 
+      interface TaxCalculationReference {
+        /**
+         * The calculation identifier for tax calculation response.
+         */
+        calculation_id: string | null;
+
+        /**
+         * The calculation identifier for tax calculation response line item.
+         */
+        calculation_item_id: string | null;
+      }
+
       type Type = 'custom_line_item' | 'invoice_line_item';
     }
   }