stripe 18.2.0 → 18.3.0.pre.alpha.1

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

@@ -124,6 +124,81 @@ 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
@@ -326,13 +401,46 @@ 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, promotion_code: nil)
+        def initialize(coupon: nil, coupon_data: nil, promotion_code: nil)
           @coupon = coupon
+          @coupon_data = coupon_data
           @promotion_code = promotion_code
         end
       end
@@ -436,6 +544,17 @@ 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.
@@ -448,6 +567,8 @@ 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,
@@ -455,7 +576,8 @@ module Stripe
               metadata: nil,
               name: nil,
               tax_code: nil,
-              unit_label: nil
+              unit_label: nil,
+              tax_details: nil
             )
               @description = description
               @images = images
@@ -463,6 +585,7 @@ module Stripe
               @name = name
               @tax_code = tax_code
               @unit_label = unit_label
+              @tax_details = tax_details
             end
           end
 
@@ -1014,6 +1137,8 @@ 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
@@ -1041,6 +1166,7 @@ module Stripe
           def initialize(
             capture_method: nil,
             installments: nil,
+            request_decremental_authorization: nil,
             request_extended_authorization: nil,
             request_incremental_authorization: nil,
             request_multicapture: nil,
@@ -1053,6 +1179,7 @@ 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
@@ -1468,6 +1595,8 @@ 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.
@@ -1480,19 +1609,25 @@ 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
+            setup_future_usage: nil,
+            subsellers: 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
 
@@ -1549,10 +1684,50 @@ 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.
@@ -1565,10 +1740,12 @@ 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
@@ -1924,6 +2101,37 @@ 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.
@@ -1931,7 +2139,15 @@ 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_shipping_details: nil)
+        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
           @update_shipping_details = update_shipping_details
         end
       end
@@ -2421,6 +2637,8 @@ 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,
@@ -2471,7 +2689,8 @@ module Stripe
         success_url: nil,
         tax_id_collection: nil,
         ui_mode: nil,
-        wallet_options: nil
+        wallet_options: nil,
+        checkout_items: nil
       )
         @adaptive_pricing = adaptive_pricing
         @after_expiration = after_expiration
@@ -2522,6 +2741,7 @@ module Stripe
         @tax_id_collection = tax_id_collection
         @ui_mode = ui_mode
         @wallet_options = wallet_options
+        @checkout_items = checkout_items
       end
     end
   end

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

@@ -4,6 +4,26 @@
 module Stripe
   module Checkout
     class SessionUpdateParams < ::Stripe::RequestParams
+      class AutomaticTax < ::Stripe::RequestParams
+        class Liability < ::Stripe::RequestParams
+          # The connected account being referenced when `type` is `account`.
+          attr_accessor :account
+          # Type of the account referenced in the request.
+          attr_accessor :type
+
+          def initialize(account: nil, type: nil)
+            @account = account
+            @type = type
+          end
+        end
+        # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
+        attr_accessor :liability
+
+        def initialize(liability: nil)
+          @liability = liability
+        end
+      end
+
       class CollectedInformation < ::Stripe::RequestParams
         class ShippingDetails < ::Stripe::RequestParams
           class Address < ::Stripe::RequestParams
@@ -54,6 +74,76 @@ module Stripe
         end
       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](https://docs.stripe.com/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.
+        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
+
+        def initialize(coupon: nil, coupon_data: nil)
+          @coupon = coupon
+          @coupon_data = coupon_data
+        end
+      end
+
+      class InvoiceCreation < ::Stripe::RequestParams
+        class InvoiceData < ::Stripe::RequestParams
+          class Issuer < ::Stripe::RequestParams
+            # The connected account being referenced when `type` is `account`.
+            attr_accessor :account
+            # Type of the account referenced in the request.
+            attr_accessor :type
+
+            def initialize(account: nil, type: nil)
+              @account = account
+              @type = type
+            end
+          end
+          # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
+          attr_accessor :issuer
+
+          def initialize(issuer: nil)
+            @issuer = issuer
+          end
+        end
+        # Parameters passed when creating invoices for payment-mode Checkout Sessions.
+        attr_accessor :invoice_data
+
+        def initialize(invoice_data: nil)
+          @invoice_data = invoice_data
+        end
+      end
+
       class LineItem < ::Stripe::RequestParams
         class AdjustableQuantity < ::Stripe::RequestParams
           # Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
@@ -72,6 +162,17 @@ 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.
@@ -84,6 +185,8 @@ 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,
@@ -91,7 +194,8 @@ module Stripe
               metadata: nil,
               name: nil,
               tax_code: nil,
-              unit_label: nil
+              unit_label: nil,
+              tax_details: nil
             )
               @description = description
               @images = images
@@ -99,6 +203,7 @@ module Stripe
               @name = name
               @tax_code = tax_code
               @unit_label = unit_label
+              @tax_details = tax_details
             end
           end
 
@@ -285,10 +390,50 @@ module Stripe
           @shipping_rate_data = shipping_rate_data
         end
       end
+
+      class SubscriptionData < ::Stripe::RequestParams
+        class InvoiceSettings < ::Stripe::RequestParams
+          class Issuer < ::Stripe::RequestParams
+            # The connected account being referenced when `type` is `account`.
+            attr_accessor :account
+            # Type of the account referenced in the request.
+            attr_accessor :type
+
+            def initialize(account: nil, type: nil)
+              @account = account
+              @type = type
+            end
+          end
+          # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
+          attr_accessor :issuer
+
+          def initialize(issuer: nil)
+            @issuer = issuer
+          end
+        end
+        # All invoices will be billed using the specified settings.
+        attr_accessor :invoice_settings
+        # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
+        attr_accessor :trial_end
+        # Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
+        attr_accessor :trial_period_days
+
+        def initialize(invoice_settings: nil, trial_end: nil, trial_period_days: nil)
+          @invoice_settings = invoice_settings
+          @trial_end = trial_end
+          @trial_period_days = trial_period_days
+        end
+      end
+      # Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
+      attr_accessor :automatic_tax
       # Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
       attr_accessor :collected_information
+      # List of coupons and promotion codes attached to the Checkout Session.
+      attr_accessor :discounts
       # Specifies which fields in the response should be expanded.
       attr_accessor :expand
+      # Generate a post-purchase Invoice for one-time payments.
+      attr_accessor :invoice_creation
       # A list of items the customer is purchasing.
       #
       # When updating line items, you must retransmit the entire array of line items.
@@ -307,19 +452,29 @@ module Stripe
       attr_accessor :metadata
       # The shipping rate options to apply to this Session. Up to a maximum of 5.
       attr_accessor :shipping_options
+      # A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
+      attr_accessor :subscription_data
 
       def initialize(
+        automatic_tax: nil,
         collected_information: nil,
+        discounts: nil,
         expand: nil,
+        invoice_creation: nil,
         line_items: nil,
         metadata: nil,
-        shipping_options: nil
+        shipping_options: nil,
+        subscription_data: nil
       )
+        @automatic_tax = automatic_tax
         @collected_information = collected_information
+        @discounts = discounts
         @expand = expand
+        @invoice_creation = invoice_creation
         @line_items = line_items
         @metadata = metadata
         @shipping_options = shipping_options
+        @subscription_data = subscription_data
       end
     end
   end