stripe 18.4.0-beta.2 → 18.4.0

package/types/Checkout/SessionsResource.d.ts

@@ -76,11 +76,6 @@ 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.
          *
@@ -163,6 +158,11 @@ declare module 'stripe' {
          */
         optional_items?: Array<SessionCreateParams.OptionalItem>;
 
+        /**
+         * Where the user is coming from. This informs the optimizations that are applied to the session. For example, a session originating from a mobile app may behave more like a native app, depending on the platform. This parameter is currently not allowed if `ui_mode` is `custom`.
+         */
+        origin_context?: SessionCreateParams.OriginContext;
+
         /**
          * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
          */
@@ -690,6 +690,11 @@ declare module 'stripe' {
               amount_tax_display?: Stripe.Emptyable<
                 RenderingOptions.AmountTaxDisplay
               >;
+
+              /**
+               * ID of the invoice rendering template to use for this invoice.
+               */
+              template?: string;
             }
 
             namespace RenderingOptions {
@@ -709,11 +714,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.
            */
@@ -919,6 +919,8 @@ declare module 'stripe' {
           }
         }
 
+        type OriginContext = 'mobile_app' | 'web';
+
         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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
@@ -1222,11 +1224,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.
            */
@@ -1496,11 +1493,6 @@ declare module 'stripe' {
              */
             installments?: Card.Installments;
 
-            /**
-             * Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
-             */
-            request_decremental_authorization?: Card.RequestDecrementalAuthorization;
-
             /**
              * Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
              */
@@ -1562,8 +1554,6 @@ declare module 'stripe' {
               enabled?: boolean;
             }
 
-            type RequestDecrementalAuthorization = 'if_available' | 'never';
-
             type RequestExtendedAuthorization = 'if_available' | 'never';
 
             type RequestIncrementalAuthorization = 'if_available' | 'never';
@@ -2009,11 +1999,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.
              */
@@ -2031,11 +2016,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 {
@@ -2065,11 +2045,11 @@ declare module 'stripe' {
             type SetupFutureUsage = 'none' | 'off_session';
           }
 
-          interface Payto {
+          interface Pix {
             /**
-             * Additional fields for Mandate creation
+             * The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
              */
-            mandate_options?: Payto.MandateOptions;
+            expires_after_seconds?: number;
 
             /**
              * Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -2080,82 +2060,7 @@ 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://docs.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.
-             */
-            expires_after_seconds?: number;
+            setup_future_usage?: 'none';
           }
 
           interface RevolutPay {
@@ -2284,11 +2189,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';
@@ -2344,7 +2245,6 @@ declare module 'stripe' {
           | 'eps'
           | 'fpx'
           | 'giropay'
-          | 'gopay'
           | 'grabpay'
           | 'ideal'
           | 'kakao_pay'
@@ -2352,26 +2252,22 @@ declare module 'stripe' {
           | 'konbini'
           | 'kr_card'
           | 'link'
-          | 'mb_way'
           | 'mobilepay'
           | 'multibanco'
           | 'naver_pay'
+          | 'nz_bank_account'
           | 'oxxo'
           | 'p24'
           | 'pay_by_bank'
           | 'payco'
           | 'paynow'
           | 'paypal'
-          | 'payto'
           | 'pix'
           | 'promptpay'
-          | 'qris'
-          | 'rechnung'
           | 'revolut_pay'
           | 'samsung_pay'
           | 'satispay'
           | 'sepa_debit'
-          | 'shopeepay'
           | 'sofort'
           | 'swish'
           | 'twint'
@@ -2380,20 +2276,6 @@ 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.
            *
@@ -2405,34 +2287,6 @@ 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';
         }
 
@@ -2954,6 +2808,9 @@ declare module 'stripe' {
 
         namespace SubscriptionData {
           interface BillingMode {
+            /**
+             * Controls the calculation and orchestration of prorations and invoices for subscriptions.
+             */
             type: BillingMode.Type;
           }
 
@@ -3078,23 +2935,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 one of `price` or `price_data` 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`.
          */
@@ -3164,146 +3004,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). One of `price` or `price_data` is required when creating a new line item.
-           */
-          price?: string;
-
-          /**
-           * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.
-           */
-          price_data?: LineItem.PriceData;
-
-          /**
-           * The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
-           */
-          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 PriceData {
-            /**
-             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-             */
-            currency: string;
-
-            /**
-             * 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](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
-             */
-            product_data?: PriceData.ProductData;
-
-            /**
-             * The recurring components of a price such as `interval` and `interval_count`.
-             */
-            recurring?: PriceData.Recurring;
-
-            /**
-             * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
-             */
-            tax_behavior?: PriceData.TaxBehavior;
-
-            /**
-             * A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
-             */
-            unit_amount?: number;
-
-            /**
-             * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
-             */
-            unit_amount_decimal?: string;
-          }
-
-          namespace PriceData {
-            interface ProductData {
-              /**
-               * The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
-               */
-              description?: string;
-
-              /**
-               * A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
-               */
-              images?: 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 product's name, meant to be displayable to the customer.
-               */
-              name: string;
-
-              /**
-               * A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
-               */
-              tax_code?: string;
-            }
-
-            interface Recurring {
-              /**
-               * Specifies billing frequency. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Recurring.Interval;
-
-              /**
-               * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
-               */
-              interval_count?: number;
-            }
-
-            namespace Recurring {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
-          }
-        }
-
         interface ShippingOption {
           /**
            * The ID of the Shipping Rate to use for this shipping option.
@@ -3454,11 +3154,6 @@ 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.
          */