stripe 18.1.0.pre.beta.1 → 18.2.0.pre.alpha.1

data/lib/stripe/resources/payment_link.rb

@@ -4,9 +4,9 @@
 module Stripe
   # A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
   #
-  # When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.
+  # When a customer opens a payment link it will open a new [checkout session](https://docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links.
   #
-  # Related guide: [Payment Links API](https://stripe.com/docs/payment-links)
+  # Related guide: [Payment Links API](https://docs.stripe.com/payment-links)
   class PaymentLink < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -352,7 +352,7 @@ module Stripe
         attr_reader :footer
         # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
         attr_reader :issuer
-        # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+        # 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.
         attr_reader :metadata
         # Options for invoice PDF rendering.
         attr_reader :rendering_options
@@ -465,7 +465,7 @@ module Stripe
       attr_reader :capture_method
       # An arbitrary string attached to the object. Often useful for displaying to users.
       attr_reader :description
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link.
       attr_reader :metadata
       # Indicates that you intend to make future payments with the payment method collected during checkout.
       attr_reader :setup_future_usage
@@ -473,7 +473,7 @@ module Stripe
       attr_reader :statement_descriptor
       # For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.
       attr_reader :statement_descriptor_suffix
-      # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
+      # A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
       attr_reader :transfer_group
 
       def self.inner_class_types
@@ -609,7 +609,7 @@ module Stripe
       attr_reader :description
       # Attribute for field invoice_settings
       attr_reader :invoice_settings
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link.
       attr_reader :metadata
       # Integer representing the number of trial period days before the customer is charged for the first time.
       attr_reader :trial_period_days
@@ -690,7 +690,7 @@ module Stripe
     attr_reader :line_items
     # 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
-    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    # 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.
     attr_reader :metadata
     # Attribute for field name_collection
     attr_reader :name_collection

data/lib/stripe/resources/payment_method.rb

@@ -3,10 +3,10 @@
 
 module Stripe
   # PaymentMethod objects represent your customer's payment instruments.
-  # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
+  # You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to
   # Customer objects to store instrument details for future payments.
   #
-  # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
+  # Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).
   class PaymentMethod < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -156,7 +156,7 @@ module Stripe
         attr_reader :line2
         # ZIP or postal code.
         attr_reader :postal_code
-        # State, county, province, or region.
+        # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
         attr_reader :state
 
         def self.inner_class_types
@@ -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
@@ -317,7 +332,7 @@ module Stripe
             attr_reader :generated_card
             # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
             attr_reader :iin
-            # Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
+            # Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
             attr_reader :incremental_authorization_supported
             # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
             attr_reader :issuer
@@ -458,7 +473,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -481,7 +496,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -535,7 +550,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -558,7 +573,7 @@ module Stripe
             attr_reader :line2
             # ZIP or postal code.
             attr_reader :postal_code
-            # State, county, province, or region.
+            # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
             attr_reader :state
 
             def self.inner_class_types
@@ -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,
@@ -909,7 +927,7 @@ module Stripe
     end
 
     class Ideal < ::Stripe::StripeObject
-      # 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`.
+      # The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `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
@@ -1259,7 +1277,7 @@ module Stripe
     end
 
     class RadarOptions < ::Stripe::StripeObject
-      # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
+      # A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
       attr_reader :session
 
       def self.inner_class_types
@@ -1596,7 +1614,7 @@ module Stripe
     attr_reader :livemode
     # Attribute for field mb_way
     attr_reader :mb_way
-    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    # 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.
     attr_reader :metadata
     # Attribute for field mobilepay
     attr_reader :mobilepay
@@ -1630,7 +1648,7 @@ module Stripe
     attr_reader :promptpay
     # Attribute for field qris
     attr_reader :qris
-    # Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
+    # Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
     attr_reader :radar_options
     # Attribute for field rechnung
     attr_reader :rechnung
@@ -1705,6 +1723,26 @@ module Stripe
       )
     end
 
+    # Retrieves a PaymentMethod'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 PaymentMethod'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.
@@ -1732,7 +1770,7 @@ module Stripe
       )
     end
 
-    # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead.
+    # Returns a list of all PaymentMethods.
     def self.list(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/payment_methods", params: params, opts: opts)
     end

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/payment_method_configuration.rb

@@ -4,7 +4,7 @@
 module Stripe
   # PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.
   #
-  # There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges):
+  # There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://docs.stripe.com/connect/charges):
   #
   # **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.
   #
@@ -13,9 +13,9 @@ module Stripe
   # Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account's associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.
   #
   # Related guides:
-  # - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations)
-  # - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs)
-  # - [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)
+  # - [Payment Method Configurations API](https://docs.stripe.com/connect/payment-method-configurations)
+  # - [Multiple configurations on dynamic payment methods](https://docs.stripe.com/payments/multiple-payment-method-configs)
+  # - [Multiple configurations for your Connect accounts](https://docs.stripe.com/connect/multiple-payment-method-configurations)
   class PaymentMethodConfiguration < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/payment_method_domain.rb

@@ -5,7 +5,7 @@ module Stripe
   # A payment method domain represents a web domain that you have registered with Stripe.
   # Stripe Elements use registered payment method domains to control where certain payment methods are shown.
   #
-  # Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
+  # Related guide: [Payment method domains](https://docs.stripe.com/payments/payment-methods/pmd-registration).
   class PaymentMethodDomain < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List