stripe 18.3.0.pre.alpha.1 → 18.3.0

data/lib/stripe/params/checkout/session_create_params.rb

@@ -124,81 +124,6 @@ module Stripe
         end
       end
 
-      class CheckoutItem < ::Stripe::RequestParams
-        class PricingPlanSubscriptionItem < ::Stripe::RequestParams
-          class ComponentConfigurations < ::Stripe::RequestParams
-            class LicenseFeeComponent < ::Stripe::RequestParams
-              # Attribute for param field quantity
-              attr_accessor :quantity
-
-              def initialize(quantity: nil)
-                @quantity = quantity
-              end
-            end
-            # Attribute for param field type
-            attr_accessor :type
-            # Attribute for param field license_fee_component
-            attr_accessor :license_fee_component
-
-            def initialize(type: nil, license_fee_component: nil)
-              @type = type
-              @license_fee_component = license_fee_component
-            end
-          end
-          # Attribute for param field pricing_plan
-          attr_accessor :pricing_plan
-          # Attribute for param field pricing_plan_version
-          attr_accessor :pricing_plan_version
-          # Attribute for param field metadata
-          attr_accessor :metadata
-          # Attribute for param field component_configurations
-          attr_accessor :component_configurations
-
-          def initialize(
-            pricing_plan: nil,
-            pricing_plan_version: nil,
-            metadata: nil,
-            component_configurations: nil
-          )
-            @pricing_plan = pricing_plan
-            @pricing_plan_version = pricing_plan_version
-            @metadata = metadata
-            @component_configurations = component_configurations
-          end
-        end
-
-        class RateCardSubscriptionItem < ::Stripe::RequestParams
-          # Attribute for param field rate_card
-          attr_accessor :rate_card
-          # Attribute for param field metadata
-          attr_accessor :metadata
-          # Attribute for param field rate_card_version
-          attr_accessor :rate_card_version
-
-          def initialize(rate_card: nil, metadata: nil, rate_card_version: nil)
-            @rate_card = rate_card
-            @metadata = metadata
-            @rate_card_version = rate_card_version
-          end
-        end
-        # Attribute for param field type
-        attr_accessor :type
-        # Attribute for param field rate_card_subscription_item
-        attr_accessor :rate_card_subscription_item
-        # Attribute for param field pricing_plan_subscription_item
-        attr_accessor :pricing_plan_subscription_item
-
-        def initialize(
-          type: nil,
-          rate_card_subscription_item: nil,
-          pricing_plan_subscription_item: nil
-        )
-          @type = type
-          @rate_card_subscription_item = rate_card_subscription_item
-          @pricing_plan_subscription_item = pricing_plan_subscription_item
-        end
-      end
-
       class ConsentCollection < ::Stripe::RequestParams
         class PaymentMethodReuseAgreement < ::Stripe::RequestParams
           # Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
@@ -401,46 +326,13 @@ module Stripe
       end
 
       class Discount < ::Stripe::RequestParams
-        class CouponData < ::Stripe::RequestParams
-          # A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
-          attr_accessor :amount_off
-          # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
-          attr_accessor :currency
-          # Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
-          attr_accessor :duration
-          # Set of [key-value pairs](https://docs.stripe.com/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`.
-          attr_accessor :metadata
-          # Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
-          attr_accessor :name
-          # A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
-          attr_accessor :percent_off
-
-          def initialize(
-            amount_off: nil,
-            currency: nil,
-            duration: nil,
-            metadata: nil,
-            name: nil,
-            percent_off: nil
-          )
-            @amount_off = amount_off
-            @currency = currency
-            @duration = duration
-            @metadata = metadata
-            @name = name
-            @percent_off = percent_off
-          end
-        end
         # The ID of the coupon to apply to this Session.
         attr_accessor :coupon
-        # Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
-        attr_accessor :coupon_data
         # The ID of a promotion code to apply to this Session.
         attr_accessor :promotion_code
 
-        def initialize(coupon: nil, coupon_data: nil, promotion_code: nil)
+        def initialize(coupon: nil, promotion_code: nil)
           @coupon = coupon
-          @coupon_data = coupon_data
           @promotion_code = promotion_code
         end
       end
@@ -544,17 +436,6 @@ module Stripe
 
         class PriceData < ::Stripe::RequestParams
           class ProductData < ::Stripe::RequestParams
-            class TaxDetails < ::Stripe::RequestParams
-              # A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
-              attr_accessor :performance_location
-              # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
-              attr_accessor :tax_code
-
-              def initialize(performance_location: nil, tax_code: nil)
-                @performance_location = performance_location
-                @tax_code = tax_code
-              end
-            end
             # 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.
             attr_accessor :description
             # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
@@ -567,8 +448,6 @@ module Stripe
             attr_accessor :tax_code
             # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
             attr_accessor :unit_label
-            # Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
-            attr_accessor :tax_details
 
             def initialize(
               description: nil,
@@ -576,8 +455,7 @@ module Stripe
               metadata: nil,
               name: nil,
               tax_code: nil,
-              unit_label: nil,
-              tax_details: nil
+              unit_label: nil
             )
               @description = description
               @images = images
@@ -585,7 +463,6 @@ module Stripe
               @name = name
               @tax_code = tax_code
               @unit_label = unit_label
-              @tax_details = tax_details
             end
           end
 
@@ -635,7 +512,7 @@ module Stripe
         end
         # When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.
         attr_accessor :adjustable_quantity
-        # The [tax rates](https://docs.stripe.com/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.
+        # The [tax rates](https://docs.stripe.com/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU. You can't set this parameter if `ui_mode` is `custom`.
         attr_accessor :dynamic_tax_rates
         # Set of [key-value pairs](https://docs.stripe.com/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`.
         attr_accessor :metadata
@@ -1137,8 +1014,6 @@ module Stripe
           # Installment options for card payments
           attr_accessor :installments
           # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
-          attr_accessor :request_decremental_authorization
-          # Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.
           attr_accessor :request_extended_authorization
           # Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.
           attr_accessor :request_incremental_authorization
@@ -1148,7 +1023,7 @@ module Stripe
           attr_accessor :request_overcapture
           # 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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
           attr_accessor :request_three_d_secure
-          # Restrictions to apply to the card payment method. For example, you can block specific card brands.
+          # Restrictions to apply to the card payment method. For example, you can block specific card brands. You can't set this parameter if `ui_mode` is `custom`.
           attr_accessor :restrictions
           # Indicates that you intend to make future payments with this PaymentIntent's payment method.
           #
@@ -1166,7 +1041,6 @@ module Stripe
           def initialize(
             capture_method: nil,
             installments: nil,
-            request_decremental_authorization: nil,
             request_extended_authorization: nil,
             request_incremental_authorization: nil,
             request_multicapture: nil,
@@ -1179,7 +1053,6 @@ module Stripe
           )
             @capture_method = capture_method
             @installments = installments
-            @request_decremental_authorization = request_decremental_authorization
             @request_extended_authorization = request_extended_authorization
             @request_incremental_authorization = request_incremental_authorization
             @request_multicapture = request_multicapture
@@ -1595,8 +1468,6 @@ module Stripe
           attr_accessor :preferred_locale
           # 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.
           attr_accessor :reference
-          # 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.
-          attr_accessor :reference_id
           # The risk correlation ID for an on-session payment using a saved PayPal payment method.
           attr_accessor :risk_correlation_id
           # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -1609,25 +1480,19 @@ 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`.
           attr_accessor :setup_future_usage
-          # 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.
-          attr_accessor :subsellers
 
           def initialize(
             capture_method: nil,
             preferred_locale: nil,
             reference: nil,
-            reference_id: nil,
             risk_correlation_id: nil,
-            setup_future_usage: nil,
-            subsellers: nil
+            setup_future_usage: nil
           )
             @capture_method = capture_method
             @preferred_locale = preferred_locale
             @reference = reference
-            @reference_id = reference_id
             @risk_correlation_id = risk_correlation_id
             @setup_future_usage = setup_future_usage
-            @subsellers = subsellers
           end
         end
 
@@ -1684,50 +1549,10 @@ module Stripe
         end
 
         class Pix < ::Stripe::RequestParams
-          class MandateOptions < ::Stripe::RequestParams
-            # Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
-            attr_accessor :amount
-            # Determines if the amount includes the IOF tax. Defaults to `never`.
-            attr_accessor :amount_includes_iof
-            # Type of amount. Defaults to `maximum`.
-            attr_accessor :amount_type
-            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
-            attr_accessor :currency
-            # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
-            attr_accessor :end_date
-            # Schedule at which the future payments will be charged. Defaults to `weekly`.
-            attr_accessor :payment_schedule
-            # Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
-            attr_accessor :reference
-            # Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
-            attr_accessor :start_date
-
-            def initialize(
-              amount: nil,
-              amount_includes_iof: nil,
-              amount_type: nil,
-              currency: nil,
-              end_date: nil,
-              payment_schedule: nil,
-              reference: nil,
-              start_date: nil
-            )
-              @amount = amount
-              @amount_includes_iof = amount_includes_iof
-              @amount_type = amount_type
-              @currency = currency
-              @end_date = end_date
-              @payment_schedule = payment_schedule
-              @reference = reference
-              @start_date = start_date
-            end
-          end
           # Determines if the amount includes the IOF tax. Defaults to `never`.
           attr_accessor :amount_includes_iof
           # The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
           attr_accessor :expires_after_seconds
-          # Additional fields for mandate creation.
-          attr_accessor :mandate_options
           # 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](/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](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
@@ -1740,12 +1565,10 @@ module Stripe
           def initialize(
             amount_includes_iof: nil,
             expires_after_seconds: nil,
-            mandate_options: nil,
             setup_future_usage: nil
           )
             @amount_includes_iof = amount_includes_iof
             @expires_after_seconds = expires_after_seconds
-            @mandate_options = mandate_options
             @setup_future_usage = setup_future_usage
           end
         end
@@ -1914,7 +1737,7 @@ module Stripe
             @setup_future_usage = setup_future_usage
           end
         end
-        # contains details about the ACSS Debit payment method options.
+        # contains details about the ACSS Debit payment method options. You can't set this parameter if `ui_mode` is `custom`.
         attr_accessor :acss_debit
         # contains details about the Affirm payment method options.
         attr_accessor :affirm
@@ -2101,37 +1924,6 @@ module Stripe
       end
 
       class Permissions < ::Stripe::RequestParams
-        class Update < ::Stripe::RequestParams
-          # 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.
-          attr_accessor :line_items
-          # 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.
-          attr_accessor :shipping_details
-
-          def initialize(line_items: nil, shipping_details: nil)
-            @line_items = line_items
-            @shipping_details = shipping_details
-          end
-        end
-        # Permissions for updating the Checkout Session.
-        attr_accessor :update
-        # Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.
-        #
-        # Default is `client_only`. Stripe Checkout client will automatically handle discount updates. If set to `server_only`, only your server is allowed to update discounts.
-        attr_accessor :update_discounts
-        # 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.
-        attr_accessor :update_line_items
         # 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.
@@ -2139,15 +1931,7 @@ module Stripe
         # 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.
         attr_accessor :update_shipping_details
 
-        def initialize(
-          update: nil,
-          update_discounts: nil,
-          update_line_items: nil,
-          update_shipping_details: nil
-        )
-          @update = update
-          @update_discounts = update_discounts
-          @update_line_items = update_line_items
+        def initialize(update_shipping_details: nil)
           @update_shipping_details = update_shipping_details
         end
       end
@@ -2384,7 +2168,7 @@ module Stripe
         end
         # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
         attr_accessor :application_fee_percent
-        # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
+        # A future timestamp to anchor the subscription's billing cycle for new subscriptions. You can't set this parameter if `ui_mode` is `custom`.
         attr_accessor :billing_cycle_anchor
         # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
         attr_accessor :billing_mode
@@ -2447,7 +2231,7 @@ module Stripe
       class TaxIdCollection < ::Stripe::RequestParams
         # Enable tax ID collection during checkout. Defaults to `false`.
         attr_accessor :enabled
-        # Describes whether a tax ID is required during checkout. Defaults to `never`.
+        # Describes whether a tax ID is required during checkout. Defaults to `never`. You can't set this parameter if `ui_mode` is `custom`.
         attr_accessor :required
 
         def initialize(enabled: nil, required: nil)
@@ -2474,7 +2258,7 @@ module Stripe
       end
       # Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
       attr_accessor :adaptive_pricing
-      # Configure actions after a Checkout Session has expired.
+      # Configure actions after a Checkout Session has expired. You can't set this parameter if `ui_mode` is `custom`.
       attr_accessor :after_expiration
       # Enables user redeemable promotion codes.
       attr_accessor :allow_promotion_codes
@@ -2494,9 +2278,9 @@ module Stripe
       attr_accessor :consent_collection
       # 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). Required in `setup` mode when `payment_method_types` is not set.
       attr_accessor :currency
-      # Collect additional information from your customer using custom fields. Up to 3 fields are supported.
+      # Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`.
       attr_accessor :custom_fields
-      # Display additional text for your customers using custom text.
+      # Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `custom`.
       attr_accessor :custom_text
       # ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card
       # payment method will be used to prefill the email, name, card details, and billing address
@@ -2557,6 +2341,8 @@ module Stripe
       # You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.
       #
       # If a [Customer](https://docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well.
+      #
+      # You can't set this parameter if `ui_mode` is `custom`.
       attr_accessor :name_collection
       # 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://docs.stripe.com/api/prices).
       #
@@ -2565,8 +2351,10 @@ module Stripe
       # 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.
+      #
+      # You can't set this parameter if `ui_mode` is `custom`.
       attr_accessor :optional_items
-      # Where the user is coming from. This informs the optimizations that are applied to the session.
+      # Where the user is coming from. This informs the optimizations that are applied to the session. You can't set this parameter if `ui_mode` is `custom`.
       attr_accessor :origin_context
       # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
       attr_accessor :payment_intent_data
@@ -2622,6 +2410,7 @@ module Stripe
       # 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.
+      # You can't set this parameter if `ui_mode` is `custom`.
       attr_accessor :submit_type
       # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
       attr_accessor :subscription_data
@@ -2637,8 +2426,6 @@ module Stripe
       attr_accessor :ui_mode
       # Wallet-specific configuration.
       attr_accessor :wallet_options
-      # Attribute for param field checkout_items
-      attr_accessor :checkout_items
 
       def initialize(
         adaptive_pricing: nil,
@@ -2689,8 +2476,7 @@ module Stripe
         success_url: nil,
         tax_id_collection: nil,
         ui_mode: nil,
-        wallet_options: nil,
-        checkout_items: nil
+        wallet_options: nil
       )
         @adaptive_pricing = adaptive_pricing
         @after_expiration = after_expiration
@@ -2741,7 +2527,6 @@ module Stripe
         @tax_id_collection = tax_id_collection
         @ui_mode = ui_mode
         @wallet_options = wallet_options
-        @checkout_items = checkout_items
       end
     end
   end