stripe 17.3.0.pre.alpha.2 → 18.1.0.pre.beta.1

data/lib/stripe/resources/payment_attempt_record.rb

@@ -897,7 +897,7 @@ module Stripe
       end
 
       class Ideal < ::Stripe::StripeObject
-        # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+        # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
         attr_reader :bank
         # The Bank Identifier Code of the customer's bank.
         attr_reader :bic
@@ -907,6 +907,8 @@ module Stripe
         attr_reader :generated_sepa_debit_mandate
         # Last four characters of the IBAN.
         attr_reader :iban_last4
+        # Unique transaction ID generated by iDEAL.
+        attr_reader :transaction_id
         # Owner's verified full name. Values are verified or provided by iDEAL directly
         # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
         attr_reader :verified_name
@@ -1681,9 +1683,9 @@ module Stripe
       end
 
       class UsBankAccount < ::Stripe::StripeObject
-        # Attribute for field account_holder_type
+        # The type of entity that holds the account. This can be either 'individual' or 'company'.
         attr_reader :account_holder_type
-        # Attribute for field account_type
+        # The type of the bank account. This can be either 'checking' or 'savings'.
         attr_reader :account_type
         # Name of the bank associated with the bank account.
         attr_reader :bank_name
@@ -1693,9 +1695,9 @@ module Stripe
         attr_reader :last4
         # ID of the mandate used to make this payment.
         attr_reader :mandate
-        # Reference number to locate ACH payments with customer’s bank.
+        # The ACH payment reference for this transaction.
         attr_reader :payment_reference
-        # Routing number of the bank account.
+        # The routing number for the bank account.
         attr_reader :routing_number
 
         def self.inner_class_types
@@ -1877,7 +1879,7 @@ module Stripe
       # An additional hash is included on `payment_method_details` with a name matching this value.
       # It contains information specific to the payment method.
       attr_reader :type
-      # Details of the US Bank Account used for this payment attempt.
+      # Attribute for field us_bank_account
       attr_reader :us_bank_account
       # Attribute for field wechat
       attr_reader :wechat

data/lib/stripe/resources/payment_intent.rb

@@ -29,11 +29,11 @@ module Stripe
 
     class AmountDetails < ::Stripe::StripeObject
       class Shipping < ::Stripe::StripeObject
-        # Portion of the amount that is for shipping.
+        # If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than or equal to 0.
         attr_reader :amount
-        # The postal code that represents the shipping source.
+        # If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed.
         attr_reader :from_postal_code
-        # The postal code that represents the shipping destination.
+        # If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed.
         attr_reader :to_postal_code
 
         def self.inner_class_types
@@ -46,7 +46,9 @@ module Stripe
       end
 
       class Tax < ::Stripe::StripeObject
-        # Total portion of the amount that is for tax.
+        # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.
+        #
+        # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.
         attr_reader :total_tax_amount
 
         def self.inner_class_types
@@ -70,7 +72,9 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # The total discount applied on the transaction.
+      # The total discount applied on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
+      #
+      # This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field.
       attr_reader :discount_amount
       # A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
       attr_reader :line_items
@@ -1181,31 +1185,6 @@ module Stripe
     end
 
     class PaymentDetails < ::Stripe::StripeObject
-      class Benefit < ::Stripe::StripeObject
-        class FrMealVoucher < ::Stripe::StripeObject
-          # The 14-digit SIRET of the meal voucher acceptor.
-          attr_reader :siret
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # Attribute for field fr_meal_voucher
-        attr_reader :fr_meal_voucher
-
-        def self.inner_class_types
-          @inner_class_types = { fr_meal_voucher: FrMealVoucher }
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-
       class CarRental < ::Stripe::StripeObject
         class Affiliate < ::Stripe::StripeObject
           # The name of the affiliate that originated the purchase.
@@ -1537,22 +1516,25 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # Attribute for field benefit
-      attr_reader :benefit
       # Attribute for field car_rental
       attr_reader :car_rental
-      # Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
+      # A unique value to identify the customer. This field is available only for card payments.
+      #
+      # This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks.
       attr_reader :customer_reference
       # Attribute for field event_details
       attr_reader :event_details
-      # A unique value assigned by the business to identify the transaction.
+      # A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.
+      #
+      # Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`.
+      #
+      # For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app.
       attr_reader :order_reference
       # Attribute for field subscription
       attr_reader :subscription
 
       def self.inner_class_types
         @inner_class_types = {
-          benefit: Benefit,
           car_rental: CarRental,
           event_details: EventDetails,
           subscription: Subscription,
@@ -2038,6 +2020,8 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # Controls when the funds will be captured from the customer's account.
+        attr_reader :capture_method
         # Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)
         attr_reader :request_extended_authorization
         # Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
@@ -2677,15 +2661,15 @@ module Stripe
         class MandateOptions < ::Stripe::StripeObject
           # Amount that will be collected. It is required when `amount_type` is `fixed`.
           attr_reader :amount
-          # 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.
+          # 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. Defaults to `maximum`.
           attr_reader :amount_type
           # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
           attr_reader :end_date
-          # The periodicity at which payments will be collected.
+          # The periodicity at which payments will be collected. Defaults to `adhoc`.
           attr_reader :payment_schedule
           # 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.
           attr_reader :payments_per_period
-          # The purpose for which payments are made. Defaults to retail.
+          # The purpose for which payments are made. Has a default value based on your merchant category code.
           attr_reader :purpose
 
           def self.inner_class_types
@@ -3434,19 +3418,6 @@ module Stripe
         @field_remappings = {}
       end
     end
-
-    class AllocatedFunds < ::Stripe::StripeObject
-      # Allocated Funds configuration for this PaymentIntent.
-      attr_reader :enabled
-
-      def self.inner_class_types
-        @inner_class_types = {}
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
     # Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
     attr_reader :amount
     # Amount that can be captured from this PaymentIntent.
@@ -3559,8 +3530,6 @@ module Stripe
     attr_reader :transfer_data
     # A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
     attr_reader :transfer_group
-    # Allocated Funds configuration for this PaymentIntent.
-    attr_reader :allocated_funds
 
     # Manually reconcile the remaining amount for a customer_balance PaymentIntent.
     def apply_customer_balance(params = {}, opts = {})
@@ -3934,7 +3903,6 @@ module Stripe
         processing: Processing,
         shipping: Shipping,
         transfer_data: TransferData,
-        allocated_funds: AllocatedFunds,
       }
     end
 

data/lib/stripe/resources/payment_intent_amount_details_line_item.rb

@@ -89,7 +89,9 @@ module Stripe
     end
 
     class Tax < ::Stripe::StripeObject
-      # Total portion of the amount that is for tax.
+      # The total amount of tax on the transaction represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.
+      #
+      # This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field.
       attr_reader :total_tax_amount
 
       def self.inner_class_types
@@ -100,7 +102,9 @@ module Stripe
         @field_remappings = {}
       end
     end
-    # The amount an item was discounted for. Positive integer.
+    # The discount applied on this line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). An integer greater than 0.
+    #
+    # This field is mutually exclusive with the `amount_details[discount_amount]` field.
     attr_reader :discount_amount
     # Unique identifier for the object.
     attr_reader :id
@@ -108,17 +112,19 @@ module Stripe
     attr_reader :object
     # Payment method-specific information for line items.
     attr_reader :payment_method_options
-    # Unique identifier of the product. At most 12 characters long.
+    # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long.
     attr_reader :product_code
-    # Name of the product. At most 100 characters long.
+    # The product name of the line item. Required for L3 rates. At most 1024 characters long.
+    #
+    # For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For Paypal, this field is truncated to 127 characters.
     attr_reader :product_name
-    # Number of items of the product. Positive integer.
+    # The quantity of items. Required for L3 rates. An integer greater than 0.
     attr_reader :quantity
     # Contains information about the tax on the item.
     attr_reader :tax
-    # Cost of the product. Non-negative integer.
+    # The unit cost of the line item represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0.
     attr_reader :unit_cost
-    # A unit of measure for the line item, such as gallons, feet, meters, etc.
+    # A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long.
     attr_reader :unit_of_measure
 
     def self.inner_class_types

data/lib/stripe/resources/payment_method.rb

@@ -211,21 +211,6 @@ module Stripe
     end
 
     class Card < ::Stripe::StripeObject
-      class Benefits < ::Stripe::StripeObject
-        # Issuer of this benefit card
-        attr_reader :issuer
-        # Available benefit programs for this card
-        attr_reader :programs
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-
       class Checks < ::Stripe::StripeObject
         # If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
         attr_reader :address_line1_check
@@ -639,8 +624,6 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # Attribute for field benefits
-      attr_reader :benefits
       # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
       attr_reader :brand
       # Checks on Card address and CVC if provided.
@@ -680,7 +663,6 @@ module Stripe
 
       def self.inner_class_types
         @inner_class_types = {
-          benefits: Benefits,
           checks: Checks,
           generated_from: GeneratedFrom,
           networks: Networks,
@@ -927,7 +909,7 @@ module Stripe
     end
 
     class Ideal < ::Stripe::StripeObject
-      # The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+      # The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
       attr_reader :bank
       # The Bank Identifier Code of the customer's bank, if the bank was provided.
       attr_reader :bic
@@ -1723,26 +1705,6 @@ module Stripe
       )
     end
 
-    # Retrieves a payment method's balance.
-    def check_balance(params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: format("/v1/payment_methods/%<payment_method>s/check_balance", { payment_method: CGI.escape(self["id"]) }),
-        params: params,
-        opts: opts
-      )
-    end
-
-    # Retrieves a payment method's balance.
-    def self.check_balance(payment_method, params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: format("/v1/payment_methods/%<payment_method>s/check_balance", { payment_method: CGI.escape(payment_method) }),
-        params: params,
-        opts: opts
-      )
-    end
-
     # Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
     #
     # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.

data/lib/stripe/resources/payment_record.rb

@@ -895,7 +895,7 @@ module Stripe
       end
 
       class Ideal < ::Stripe::StripeObject
-        # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+        # The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
         attr_reader :bank
         # The Bank Identifier Code of the customer's bank.
         attr_reader :bic
@@ -905,6 +905,8 @@ module Stripe
         attr_reader :generated_sepa_debit_mandate
         # Last four characters of the IBAN.
         attr_reader :iban_last4
+        # Unique transaction ID generated by iDEAL.
+        attr_reader :transaction_id
         # Owner's verified full name. Values are verified or provided by iDEAL directly
         # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
         attr_reader :verified_name
@@ -1679,9 +1681,9 @@ module Stripe
       end
 
       class UsBankAccount < ::Stripe::StripeObject
-        # Attribute for field account_holder_type
+        # The type of entity that holds the account. This can be either 'individual' or 'company'.
         attr_reader :account_holder_type
-        # Attribute for field account_type
+        # The type of the bank account. This can be either 'checking' or 'savings'.
         attr_reader :account_type
         # Name of the bank associated with the bank account.
         attr_reader :bank_name
@@ -1691,9 +1693,9 @@ module Stripe
         attr_reader :last4
         # ID of the mandate used to make this payment.
         attr_reader :mandate
-        # Reference number to locate ACH payments with customer’s bank.
+        # The ACH payment reference for this transaction.
         attr_reader :payment_reference
-        # Routing number of the bank account.
+        # The routing number for the bank account.
         attr_reader :routing_number
 
         def self.inner_class_types
@@ -1875,7 +1877,7 @@ module Stripe
       # An additional hash is included on `payment_method_details` with a name matching this value.
       # It contains information specific to the payment method.
       attr_reader :type
-      # Details of the US Bank Account used for this payment attempt.
+      # Attribute for field us_bank_account
       attr_reader :us_bank_account
       # Attribute for field wechat
       attr_reader :wechat

data/lib/stripe/resources/person.rb

@@ -395,36 +395,6 @@ module Stripe
         @field_remappings = {}
       end
     end
-
-    class SelfReportedIncome < ::Stripe::StripeObject
-      # Amount in the minor currency unit (e.g., cents for USD)
-      attr_reader :amount
-      # 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).
-      attr_reader :currency
-
-      def self.inner_class_types
-        @inner_class_types = {}
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-
-    class SelfReportedMonthlyHousingPayment < ::Stripe::StripeObject
-      # Amount in the minor currency unit (e.g., cents for USD)
-      attr_reader :amount
-      # 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).
-      attr_reader :currency
-
-      def self.inner_class_types
-        @inner_class_types = {}
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
     # The account the person is associated with.
     attr_reader :account
     # Attribute for field additional_tos_acceptances
@@ -489,10 +459,6 @@ module Stripe
     attr_reader :us_cfpb_data
     # Attribute for field verification
     attr_reader :verification
-    # Attribute for field self_reported_income
-    attr_reader :self_reported_income
-    # Attribute for field self_reported_monthly_housing_payment
-    attr_reader :self_reported_monthly_housing_payment
     # Always true for a deleted object
     attr_reader :deleted
 
@@ -530,8 +496,6 @@ module Stripe
         requirements: Requirements,
         us_cfpb_data: UsCfpbData,
         verification: Verification,
-        self_reported_income: SelfReportedIncome,
-        self_reported_monthly_housing_payment: SelfReportedMonthlyHousingPayment,
       }
     end