stripe 17.8.0-beta.1 → 18.0.0

package/types/Checkout/SessionsResource.d.ts

@@ -147,6 +147,17 @@ declare module 'stripe' {
          */
         mode?: SessionCreateParams.Mode;
 
+        /**
+         * A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
+         *
+         * There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.
+         *
+         * For `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.
+         *
+         * For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.
+         */
+        optional_items?: Array<SessionCreateParams.OptionalItem>;
+
         /**
          * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
          */
@@ -240,9 +251,10 @@ declare module 'stripe' {
         shipping_options?: Array<SessionCreateParams.ShippingOption>;
 
         /**
-         * Describes the type of transaction being performed by Checkout in order to customize
-         * relevant text on the page, such as the submit button. `submit_type` can only be
-         * specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
+         * Describes the type of transaction being performed by Checkout in order
+         * to customize relevant text on the page, such as the submit button.
+         *  `submit_type` can only be specified on Checkout Sessions in
+         * `payment` or `subscription` mode. If blank or `auto`, `pay` is used.
          */
         submit_type?: SessionCreateParams.SubmitType;
 
@@ -687,11 +699,6 @@ 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.
            */
@@ -738,12 +745,12 @@ declare module 'stripe' {
             currency: string;
 
             /**
-             * The ID of the product that this price will belong to. One of `product` or `product_data` is required.
+             * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
              */
             product?: string;
 
             /**
-             * Data used to generate a new product object inline. One of `product` or `product_data` is required.
+             * Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
              */
             product_data?: PriceData.ProductData;
 
@@ -861,9 +868,45 @@ declare module 'stripe' {
 
         type Mode = 'payment' | 'setup' | 'subscription';
 
+        interface OptionalItem {
+          /**
+           * When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
+           */
+          adjustable_quantity?: OptionalItem.AdjustableQuantity;
+
+          /**
+           * The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
+           */
+          price: string;
+
+          /**
+           * The initial quantity of the line item created when a customer chooses to add this optional item to their order.
+           */
+          quantity: number;
+        }
+
+        namespace OptionalItem {
+          interface AdjustableQuantity {
+            /**
+             * Set to true if the quantity can be adjusted to any non-negative integer.
+             */
+            enabled: boolean;
+
+            /**
+             * The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
+             */
+            maximum?: number;
+
+            /**
+             * The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
+             */
+            minimum?: number;
+          }
+        }
+
         interface PaymentIntentData {
           /**
-           * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
+           * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
            */
           application_fee_amount?: number;
 
@@ -1164,11 +1207,6 @@ 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.
            */
@@ -1438,11 +1476,6 @@ 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.
              */
@@ -1504,8 +1537,6 @@ declare module 'stripe' {
               enabled?: boolean;
             }
 
-            type RequestDecrementalAuthorization = 'if_available' | 'never';
-
             type RequestExtendedAuthorization = 'if_available' | 'never';
 
             type RequestIncrementalAuthorization = 'if_available' | 'never';
@@ -1901,11 +1932,6 @@ 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.
              */
@@ -1923,11 +1949,6 @@ 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 {
@@ -1957,92 +1978,6 @@ 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.
@@ -2176,11 +2111,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
@@ -2226,6 +2157,7 @@ declare module 'stripe' {
           | 'au_becs_debit'
           | 'bacs_debit'
           | 'bancontact'
+          | 'billie'
           | 'blik'
           | 'boleto'
           | 'card'
@@ -2234,7 +2166,6 @@ declare module 'stripe' {
           | 'eps'
           | 'fpx'
           | 'giropay'
-          | 'gopay'
           | 'grabpay'
           | 'ideal'
           | 'kakao_pay'
@@ -2242,7 +2173,6 @@ declare module 'stripe' {
           | 'konbini'
           | 'kr_card'
           | 'link'
-          | 'mb_way'
           | 'mobilepay'
           | 'multibanco'
           | 'naver_pay'
@@ -2252,15 +2182,12 @@ declare module 'stripe' {
           | 'payco'
           | 'paynow'
           | 'paypal'
-          | 'payto'
           | 'pix'
           | 'promptpay'
-          | 'qris'
-          | 'rechnung'
           | 'revolut_pay'
           | 'samsung_pay'
+          | 'satispay'
           | 'sepa_debit'
-          | 'shopeepay'
           | 'sofort'
           | 'swish'
           | 'twint'
@@ -2270,37 +2197,17 @@ declare module 'stripe' {
 
         interface Permissions {
           /**
-           * Permissions for updating the Checkout Session.
+           * 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.
            */
-          update?: Permissions.Update;
+          update_shipping_details?: Permissions.UpdateShippingDetails;
         }
 
         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 UpdateShippingDetails = 'client_only' | 'server_only';
         }
 
         interface PhoneNumberCollection {
@@ -2908,23 +2815,6 @@ 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`. We don't currently support recurring prices.
-         *
-         * 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`.
          */
@@ -2994,57 +2884,6 @@ 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.
@@ -3184,63 +3023,6 @@ declare module 'stripe' {
         }
       }
 
-      namespace SessionUpdateParams {
-        interface CollectedInformation {
-          /**
-           * The shipping details to apply to this Session.
-           */
-          shipping_details?: CollectedInformation.ShippingDetails;
-        }
-
-        namespace CollectedInformation {
-          interface ShippingDetails {
-            /**
-             * The address of the customer
-             */
-            address: ShippingDetails.Address;
-
-            /**
-             * The name of customer
-             */
-            name: string;
-          }
-
-          namespace ShippingDetails {
-            interface Address {
-              /**
-               * City, district, suburb, town, or village.
-               */
-              city?: string;
-
-              /**
-               * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
-               */
-              country: string;
-
-              /**
-               * Address line 1 (e.g., street, PO Box, or company name).
-               */
-              line1: string;
-
-              /**
-               * Address line 2 (e.g., apartment, suite, unit, or building).
-               */
-              line2?: string;
-
-              /**
-               * ZIP or postal code.
-               */
-              postal_code?: string;
-
-              /**
-               * State, county, province, or region.
-               */
-              state?: string;
-            }
-          }
-        }
-      }
-
       interface SessionListParams extends PaginationParams {
         /**
          * Only return Checkout Sessions that were created during the given date interval.
@@ -3310,7 +3092,7 @@ declare module 'stripe' {
 
       class SessionsResource {
         /**
-         * Creates a Session object.
+         * Creates a Checkout Session object.
          */
         create(
           params?: SessionCreateParams,
@@ -3321,7 +3103,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Checkout.Session>>;
 
         /**
-         * Retrieves a Session object.
+         * Retrieves a Checkout Session object.
          */
         retrieve(
           id: string,
@@ -3334,7 +3116,7 @@ declare module 'stripe' {
         ): Promise<Stripe.Response<Stripe.Checkout.Session>>;
 
         /**
-         * Updates a Session object.
+         * Updates a Checkout Session object.
          */
         update(
           id: string,
@@ -3352,9 +3134,9 @@ declare module 'stripe' {
         list(options?: RequestOptions): ApiListPromise<Stripe.Checkout.Session>;
 
         /**
-         * A Session can be expired when it is in one of these statuses: open
+         * A Checkout Session can be expired when it is in one of these statuses: open
          *
-         * After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
+         * After it expires, a customer can't complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.
          */
         expire(
           id: string,