stripe 17.2.0.pre.beta.1 → 17.3.0.pre.alpha.1

data/lib/stripe/resources/invoice_item.rb

@@ -22,6 +22,44 @@ module Stripe
     end
 
     class Parent < ::Stripe::StripeObject
+      class LicenseFeeSubscriptionDetails < ::Stripe::StripeObject
+        # The license fee subscription that generated this invoice item
+        attr_reader :license_fee_subscription
+        # The license fee version that generated this invoice item
+        attr_reader :license_fee_version
+        # The pricing plan subscription that manages the license fee subscription
+        attr_reader :pricing_plan_subscription
+        # The pricing plan version at the time this invoice item was generated
+        attr_reader :pricing_plan_version
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RateCardSubscriptionDetails < ::Stripe::StripeObject
+        # The pricing plan subscription that manages the rate card subscription
+        attr_reader :pricing_plan_subscription
+        # The pricing plan version at the time this invoice item was generated
+        attr_reader :pricing_plan_version
+        # The rate card subscription that generated this invoice item
+        attr_reader :rate_card_subscription
+        # The rate card version that generated this invoice item
+        attr_reader :rate_card_version
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class SubscriptionDetails < ::Stripe::StripeObject
         # The subscription that generated this invoice item
         attr_reader :subscription
@@ -36,13 +74,21 @@ module Stripe
           @field_remappings = {}
         end
       end
+      # Details about the license fee subscription that generated this invoice item
+      attr_reader :license_fee_subscription_details
+      # Details about the rate card subscription that generated this invoice item
+      attr_reader :rate_card_subscription_details
       # Details about the subscription that generated this invoice item
       attr_reader :subscription_details
       # The type of parent that generated this invoice item
       attr_reader :type
 
       def self.inner_class_types
-        @inner_class_types = { subscription_details: SubscriptionDetails }
+        @inner_class_types = {
+          license_fee_subscription_details: LicenseFeeSubscriptionDetails,
+          rate_card_subscription_details: RateCardSubscriptionDetails,
+          subscription_details: SubscriptionDetails,
+        }
       end
 
       def self.field_remappings
@@ -66,6 +112,23 @@ module Stripe
     end
 
     class Pricing < ::Stripe::StripeObject
+      class LicenseFeeDetails < ::Stripe::StripeObject
+        # The ID of the license fee this item is associated with
+        attr_reader :license_fee
+        # The version of the license fee this item is associated with
+        attr_reader :license_fee_version
+        # The ID of the licensed item this item is associated with
+        attr_reader :licensed_item
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class PriceDetails < ::Stripe::StripeObject
         # The ID of the price this item is associated with.
         attr_reader :price
@@ -80,15 +143,40 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class RateCardRateDetails < ::Stripe::StripeObject
+        # The ID of billable item this item is associated with
+        attr_reader :metered_item
+        # The ID of the rate card this item is associated with
+        attr_reader :rate_card
+        # The ID of the rate card rate this item is associated with
+        attr_reader :rate_card_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field license_fee_details
+      attr_reader :license_fee_details
       # Attribute for field price_details
       attr_reader :price_details
+      # Attribute for field rate_card_rate_details
+      attr_reader :rate_card_rate_details
       # The type of the pricing details.
       attr_reader :type
       # The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
       attr_reader :unit_amount_decimal
 
       def self.inner_class_types
-        @inner_class_types = { price_details: PriceDetails }
+        @inner_class_types = {
+          license_fee_details: LicenseFeeDetails,
+          price_details: PriceDetails,
+          rate_card_rate_details: RateCardRateDetails,
+        }
       end
 
       def self.field_remappings

data/lib/stripe/resources/invoice_line_item.rb

@@ -89,6 +89,48 @@ module Stripe
         end
       end
 
+      class LicenseFeeSubscriptionDetails < ::Stripe::StripeObject
+        # The invoice item that generated this line item
+        attr_reader :invoice_item
+        # The license fee subscription that generated this line item
+        attr_reader :license_fee_subscription
+        # The license fee version at the time this line item was generated
+        attr_reader :license_fee_version
+        # The pricing plan subscription that manages the license fee subscription
+        attr_reader :pricing_plan_subscription
+        # The pricing plan version at the time this line item was generated
+        attr_reader :pricing_plan_version
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RateCardSubscriptionDetails < ::Stripe::StripeObject
+        # The invoice item that generated this line item
+        attr_reader :invoice_item
+        # The pricing plan subscription that manages the rate card subscription
+        attr_reader :pricing_plan_subscription
+        # The pricing plan version at the time this line item was generated
+        attr_reader :pricing_plan_version
+        # The rate card subscription that generated this line item
+        attr_reader :rate_card_subscription
+        # The rate card version at the time this line item was generated
+        attr_reader :rate_card_version
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class SubscriptionItemDetails < ::Stripe::StripeObject
         class ProrationDetails < ::Stripe::StripeObject
           class CreditedItems < ::Stripe::StripeObject
@@ -137,6 +179,10 @@ module Stripe
       end
       # Details about the invoice item that generated this line item
       attr_reader :invoice_item_details
+      # Details about the license fee subscription that generated this line item
+      attr_reader :license_fee_subscription_details
+      # Details about the rate card subscription that generated this line item
+      attr_reader :rate_card_subscription_details
       # Details about the subscription item that generated this line item
       attr_reader :subscription_item_details
       # The type of parent that generated this line item
@@ -145,6 +191,8 @@ module Stripe
       def self.inner_class_types
         @inner_class_types = {
           invoice_item_details: InvoiceItemDetails,
+          license_fee_subscription_details: LicenseFeeSubscriptionDetails,
+          rate_card_subscription_details: RateCardSubscriptionDetails,
           subscription_item_details: SubscriptionItemDetails,
         }
       end
@@ -191,6 +239,23 @@ module Stripe
     end
 
     class Pricing < ::Stripe::StripeObject
+      class LicenseFeeDetails < ::Stripe::StripeObject
+        # The ID of the license fee this item is associated with
+        attr_reader :license_fee
+        # The version of the license fee this item is associated with
+        attr_reader :license_fee_version
+        # The ID of the licensed item this item is associated with
+        attr_reader :licensed_item
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class PriceDetails < ::Stripe::StripeObject
         # The ID of the price this item is associated with.
         attr_reader :price
@@ -205,15 +270,40 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class RateCardRateDetails < ::Stripe::StripeObject
+        # The ID of billable item this item is associated with
+        attr_reader :metered_item
+        # The ID of the rate card this item is associated with
+        attr_reader :rate_card
+        # The ID of the rate card rate this item is associated with
+        attr_reader :rate_card_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field license_fee_details
+      attr_reader :license_fee_details
       # Attribute for field price_details
       attr_reader :price_details
+      # Attribute for field rate_card_rate_details
+      attr_reader :rate_card_rate_details
       # The type of the pricing details.
       attr_reader :type
       # The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
       attr_reader :unit_amount_decimal
 
       def self.inner_class_types
-        @inner_class_types = { price_details: PriceDetails }
+        @inner_class_types = {
+          license_fee_details: LicenseFeeDetails,
+          price_details: PriceDetails,
+          rate_card_rate_details: RateCardRateDetails,
+        }
       end
 
       def self.field_remappings

data/lib/stripe/resources/payment_intent.rb

@@ -29,11 +29,11 @@ module Stripe
 
     class AmountDetails < ::Stripe::StripeObject
       class Shipping < ::Stripe::StripeObject
-        # 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.
+        # Portion of the amount that is for shipping.
         attr_reader :amount
-        # 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.
+        # The postal code that represents the shipping source.
         attr_reader :from_postal_code
-        # 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.
+        # The postal code that represents the shipping destination.
         attr_reader :to_postal_code
 
         def self.inner_class_types
@@ -46,9 +46,7 @@ module Stripe
       end
 
       class Tax < ::Stripe::StripeObject
-        # 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.
+        # Total portion of the amount that is for tax.
         attr_reader :total_tax_amount
 
         def self.inner_class_types
@@ -72,9 +70,7 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # 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.
+      # The total discount applied on the transaction.
       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
@@ -1185,6 +1181,31 @@ 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.
@@ -1516,25 +1537,22 @@ module Stripe
           @field_remappings = {}
         end
       end
+      # Attribute for field benefit
+      attr_reader :benefit
       # Attribute for field car_rental
       attr_reader :car_rental
-      # 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.
+      # 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.
       attr_reader :customer_reference
       # Attribute for field event_details
       attr_reader :event_details
-      # 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.
+      # A unique value assigned by the business to identify the transaction.
       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,
@@ -3416,6 +3434,19 @@ 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.
@@ -3528,6 +3559,8 @@ 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 = {})
@@ -3901,6 +3934,7 @@ 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,9 +89,7 @@ module Stripe
     end
 
     class Tax < ::Stripe::StripeObject
-      # 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.
+      # Total portion of the amount that is for tax.
       attr_reader :total_tax_amount
 
       def self.inner_class_types
@@ -102,9 +100,7 @@ module Stripe
         @field_remappings = {}
       end
     end
-    # 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.
+    # The amount an item was discounted for. Positive integer.
     attr_reader :discount_amount
     # Unique identifier for the object.
     attr_reader :id
@@ -112,19 +108,17 @@ module Stripe
     attr_reader :object
     # Payment method-specific information for line items.
     attr_reader :payment_method_options
-    # The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long.
+    # Unique identifier of the product. At most 12 characters long.
     attr_reader :product_code
-    # 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.
+    # Name of the product. At most 100 characters long.
     attr_reader :product_name
-    # The quantity of items. Required for L3 rates. An integer greater than 0.
+    # Number of items of the product. Positive integer.
     attr_reader :quantity
     # Contains information about the tax on the item.
     attr_reader :tax
-    # 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.
+    # Cost of the product. Non-negative integer.
     attr_reader :unit_cost
-    # A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long.
+    # A unit of measure for the line item, such as gallons, feet, meters, etc.
     attr_reader :unit_of_measure
 
     def self.inner_class_types

data/lib/stripe/resources/payment_method.rb

@@ -211,6 +211,21 @@ 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
@@ -624,6 +639,8 @@ 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.
@@ -663,6 +680,7 @@ module Stripe
 
       def self.inner_class_types
         @inner_class_types = {
+          benefits: Benefits,
           checks: Checks,
           generated_from: GeneratedFrom,
           networks: Networks,
@@ -1705,6 +1723,26 @@ 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_method_balance.rb

@@ -0,0 +1,68 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # PaymentMethodBalance objects represent balances available on a payment method.
+  # You can use v1/payment_methods/:id/check_balance to check the balance of a payment method.
+  class PaymentMethodBalance < APIResource
+    OBJECT_NAME = "payment_method_balance"
+    def self.object_name
+      "payment_method_balance"
+    end
+
+    class Balance < ::Stripe::StripeObject
+      class FrMealVoucher < ::Stripe::StripeObject
+        class Available < ::Stripe::StripeObject
+          # The amount of the balance.
+          attr_reader :amount
+          # The currency of the balance.
+          attr_reader :currency
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The hashes of balances and amounts for available balances.
+        attr_reader :available
+
+        def self.inner_class_types
+          @inner_class_types = { available: Available }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The available FR Meal Voucher balances.
+      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
+    # The time at which the balance was calculated. Measured in seconds since the Unix epoch.
+    attr_reader :as_of
+    # BalanceEntry contain information about every individual balance type of a card.
+    attr_reader :balance
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+
+    def self.inner_class_types
+      @inner_class_types = { balance: Balance }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/setup_intent.rb

@@ -656,6 +656,43 @@ module Stripe
         @field_remappings = {}
       end
     end
+
+    class SetupDetails < ::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
+      # Attribute for field benefit
+      attr_reader :benefit
+
+      def self.inner_class_types
+        @inner_class_types = { benefit: Benefit }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
     # ID of the Connect application that created the SetupIntent.
     attr_reader :application
     # If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.
@@ -714,6 +751,8 @@ module Stripe
     attr_reader :payment_method_options
     # The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type).
     attr_reader :payment_method_types
+    # Attribute for field setup_details
+    attr_reader :setup_details
     # ID of the single_use Mandate generated by the SetupIntent.
     attr_reader :single_use_mandate
     # [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
@@ -843,6 +882,7 @@ module Stripe
         next_action: NextAction,
         payment_method_configuration_details: PaymentMethodConfigurationDetails,
         payment_method_options: PaymentMethodOptions,
+        setup_details: SetupDetails,
       }
     end
 

data/lib/stripe/resources/transfer.rb

@@ -61,6 +61,10 @@ module Stripe
     attr_reader :source_type
     # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
     attr_reader :transfer_group
+    # Attribute for field application_fee
+    attr_reader :application_fee
+    # Attribute for field application_fee_amount
+    attr_reader :application_fee_amount
 
     # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
     def self.create(params = {}, opts = {})