stripe 17.0.0 → 17.1.0.pre.beta.1

data/lib/stripe/resources/financial_connections/institution.rb

@@ -0,0 +1,127 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
+    class Institution < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "financial_connections.institution"
+      def self.object_name
+        "financial_connections.institution"
+      end
+
+      class Features < Stripe::StripeObject
+        class Balances < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Ownership < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class PaymentMethod < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Transactions < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field balances
+        attr_reader :balances
+        # Attribute for field ownership
+        attr_reader :ownership
+        # Attribute for field payment_method
+        attr_reader :payment_method
+        # Attribute for field transactions
+        attr_reader :transactions
+
+        def self.inner_class_types
+          @inner_class_types = {
+            balances: Balances,
+            ownership: Ownership,
+            payment_method: PaymentMethod,
+            transactions: Transactions,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The list of countries supported by this institution, formatted as ISO country codes.
+      attr_reader :countries
+      # Attribute for field features
+      attr_reader :features
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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
+      # The name of this institution.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
+      attr_reader :routing_numbers
+      # The status of this institution in the Financial Connections authentication flow.
+      attr_reader :status
+      # A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
+      attr_reader :url
+
+      # Returns a list of Financial Connections Institution objects.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/financial_connections/institutions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { features: Features }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/financial_connections/session.rb

@@ -17,6 +17,8 @@ module Stripe
         attr_reader :account
         # ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
         attr_reader :customer
+        # Attribute for field customer_account
+        attr_reader :customer_account
         # Type of account holder that this account belongs to.
         attr_reader :type
 
@@ -34,6 +36,8 @@ module Stripe
         attr_reader :account_subcategories
         # List of countries from which to filter accounts.
         attr_reader :countries
+        # Stripe ID of the institution with which the customer should be directed to log in.
+        attr_reader :institution
 
         def self.inner_class_types
           @inner_class_types = {}
@@ -43,6 +47,54 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class Limits < Stripe::StripeObject
+        # The number of accounts that can be linked in this Session.
+        attr_reader :accounts
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ManualEntry < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusDetails < Stripe::StripeObject
+        class Cancelled < Stripe::StripeObject
+          # The reason for the Session being cancelled.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field cancelled
+        attr_reader :cancelled
+
+        def self.inner_class_types
+          @inner_class_types = { cancelled: Cancelled }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
       # The account holder for whom accounts are collected in this session.
       attr_reader :account_holder
       # The accounts that were collected as part of this Session.
@@ -53,8 +105,12 @@ module Stripe
       attr_reader :filters
       # Unique identifier for the object.
       attr_reader :id
+      # Attribute for field limits
+      attr_reader :limits
       # 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
+      # Attribute for field manual_entry
+      attr_reader :manual_entry
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Permissions requested for accounts collected during this session.
@@ -63,6 +119,10 @@ module Stripe
       attr_reader :prefetch
       # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
       attr_reader :return_url
+      # The current state of the session.
+      attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
 
       # To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
       def self.create(params = {}, opts = {})
@@ -75,7 +135,13 @@ module Stripe
       end
 
       def self.inner_class_types
-        @inner_class_types = { account_holder: AccountHolder, filters: Filters }
+        @inner_class_types = {
+          account_holder: AccountHolder,
+          filters: Filters,
+          limits: Limits,
+          manual_entry: ManualEntry,
+          status_details: StatusDetails,
+        }
       end
 
       def self.field_remappings

data/lib/stripe/resources/fx_quote.rb

@@ -0,0 +1,147 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # The FX Quotes API provides three functions:
+  # - View Stripe's current exchange rate for any given currency pair.
+  # - Extend quoted rates for a 1-hour period or a 24-hour period, minimizing uncertainty from FX fluctuations.
+  # - Preview the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.
+  #
+  # [View the docs](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api)
+  class FxQuote < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "fx_quote"
+    def self.object_name
+      "fx_quote"
+    end
+
+    class Rates < Stripe::StripeObject
+      class RateDetails < Stripe::StripeObject
+        # The rate for the currency pair.
+        attr_reader :base_rate
+        # The fee for locking the conversion rates.
+        attr_reader :duration_premium
+        # The FX fee for the currency pair.
+        attr_reader :fx_fee_rate
+        # A reference rate for the currency pair provided by the reference rate provider.
+        attr_reader :reference_rate
+        # The reference rate provider.
+        attr_reader :reference_rate_provider
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The rate that includes the FX fee rate.
+      attr_reader :exchange_rate
+      # Attribute for field rate_details
+      attr_reader :rate_details
+
+      def self.inner_class_types
+        @inner_class_types = { rate_details: RateDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Usage < Stripe::StripeObject
+      class Payment < Stripe::StripeObject
+        # The Stripe account ID that the funds will be transferred to.
+        #
+        # This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.
+        attr_reader :destination
+        # The Stripe account ID that these funds are intended for.
+        #
+        # This field must match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
+        attr_reader :on_behalf_of
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Transfer < Stripe::StripeObject
+        # The Stripe account ID that the funds will be transferred to.
+        #
+        # This field should match the account ID that would be used in the Transfer’s destination field.
+        attr_reader :destination
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The details required to use an FX Quote for a payment
+      attr_reader :payment
+      # The details required to use an FX Quote for a transfer
+      attr_reader :transfer
+      # The transaction type for which the FX Quote will be used.
+      #
+      # Can be 'payment' or 'transfer'.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { payment: Payment, transfer: Transfer }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Time at which the quote was created, measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Unique identifier for the object.
+    attr_reader :id
+    # The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won't be usable for any transactions.
+    attr_reader :lock_duration
+    # Time at which the quote will expire, measured in seconds since the Unix epoch.
+    #
+    # If lock_duration is set to ‘none’ this field will be set to null.
+    attr_reader :lock_expires_at
+    # Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.
+    #
+    # Can return value none, active, or expired.
+    attr_reader :lock_status
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Information about the rates.
+    attr_reader :rates
+    # The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.
+    attr_reader :to_currency
+    # Attribute for field usage
+    attr_reader :usage
+
+    # Creates an FX Quote object
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/fx_quotes", params: params, opts: opts)
+    end
+
+    # Returns a list of FX quotes that have been issued. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/fx_quotes", params: params, opts: opts)
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { rates: Rates, usage: Usage }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/identity/verification_session.rb

@@ -275,6 +275,8 @@ module Stripe
       attr_reader :redaction
       # Customer ID
       attr_reader :related_customer
+      # Token referencing a Customer Account resource.
+      attr_reader :related_customer_account
       # Attribute for field related_person
       attr_reader :related_person
       # Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).

data/lib/stripe/resources/invoice.rb

@@ -49,6 +49,33 @@ module Stripe
 
     nested_resource_class_methods :line, operations: %i[list]
 
+    class AmountsDue < Stripe::StripeObject
+      # Incremental amount due for this payment in cents (or local equivalent).
+      attr_reader :amount
+      # The amount in cents (or local equivalent) that was paid for this payment.
+      attr_reader :amount_paid
+      # The difference between the payment’s amount and amount_paid, in cents (or local equivalent).
+      attr_reader :amount_remaining
+      # Number of days from when invoice is finalized until the payment is due.
+      attr_reader :days_until_due
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_reader :description
+      # Date on which a payment plan’s payment is due.
+      attr_reader :due_date
+      # Timestamp when the payment was paid.
+      attr_reader :paid_at
+      # The status of the payment, one of `open`, `paid`, or `past_due`
+      attr_reader :status
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class AutomaticTax < Stripe::StripeObject
       class Liability < Stripe::StripeObject
         # The connected account being referenced when `type` is `account`.
@@ -303,6 +330,19 @@ module Stripe
     end
 
     class Parent < Stripe::StripeObject
+      class BillingCadenceDetails < Stripe::StripeObject
+        # The billing cadence that generated this invoice
+        attr_reader :billing_cadence
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class QuoteDetails < Stripe::StripeObject
         # The quote that generated this invoice
         attr_reader :quote
@@ -317,22 +357,40 @@ module Stripe
       end
 
       class SubscriptionDetails < Stripe::StripeObject
+        class PauseCollection < Stripe::StripeObject
+          # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
+          attr_reader :behavior
+          # The time after which the subscription will resume collecting payments.
+          attr_reader :resumes_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
         # Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
         #  *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
         attr_reader :metadata
+        # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
+        attr_reader :pause_collection
         # The subscription that generated this invoice
         attr_reader :subscription
         # Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
         attr_reader :subscription_proration_date
 
         def self.inner_class_types
-          @inner_class_types = {}
+          @inner_class_types = { pause_collection: PauseCollection }
         end
 
         def self.field_remappings
           @field_remappings = {}
         end
       end
+      # Details about the billing cadence that generated this invoice
+      attr_reader :billing_cadence_details
       # Details about the quote that generated this invoice
       attr_reader :quote_details
       # Details about the subscription that generated this invoice
@@ -342,6 +400,7 @@ module Stripe
 
       def self.inner_class_types
         @inner_class_types = {
+          billing_cadence_details: BillingCadenceDetails,
           quote_details: QuoteDetails,
           subscription_details: SubscriptionDetails,
         }
@@ -462,6 +521,16 @@ module Stripe
           end
         end
 
+        class IdBankTransfer < Stripe::StripeObject
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class Konbini < Stripe::StripeObject
           def self.inner_class_types
             @inner_class_types = {}
@@ -472,6 +541,19 @@ module Stripe
           end
         end
 
+        class Pix < Stripe::StripeObject
+          # Determines if the amount includes the IOF tax.
+          attr_reader :amount_includes_iof
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class SepaDebit < Stripe::StripeObject
           def self.inner_class_types
             @inner_class_types = {}
@@ -482,11 +564,44 @@ module Stripe
           end
         end
 
+        class Upi < Stripe::StripeObject
+          class MandateOptions < Stripe::StripeObject
+            # Amount to be charged for future payments.
+            attr_reader :amount
+            # One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
+            attr_reader :amount_type
+            # A description of the mandate or subscription that is meant to be displayed to the customer.
+            attr_reader :description
+            # End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+            attr_reader :end_date
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Attribute for field mandate_options
+          attr_reader :mandate_options
+
+          def self.inner_class_types
+            @inner_class_types = { mandate_options: MandateOptions }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class UsBankAccount < Stripe::StripeObject
           class FinancialConnections < Stripe::StripeObject
             class Filters < Stripe::StripeObject
               # The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
               attr_reader :account_subcategories
+              # The institution to use to filter for possible accounts to link.
+              attr_reader :institution
 
               def self.inner_class_types
                 @inner_class_types = {}
@@ -532,10 +647,16 @@ module Stripe
         attr_reader :card
         # If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
         attr_reader :customer_balance
+        # If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice’s PaymentIntent.
+        attr_reader :id_bank_transfer
         # If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
         attr_reader :konbini
+        # If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
+        attr_reader :pix
         # If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
         attr_reader :sepa_debit
+        # If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
+        attr_reader :upi
         # If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
         attr_reader :us_bank_account
 
@@ -545,8 +666,11 @@ module Stripe
             bancontact: Bancontact,
             card: Card,
             customer_balance: CustomerBalance,
+            id_bank_transfer: IdBankTransfer,
             konbini: Konbini,
+            pix: Pix,
             sepa_debit: SepaDebit,
+            upi: Upi,
             us_bank_account: UsBankAccount,
           }
         end
@@ -749,6 +873,21 @@ module Stripe
       end
     end
 
+    class TotalMarginAmount < Stripe::StripeObject
+      # The amount, in cents (or local equivalent), of the reduction in line item amount.
+      attr_reader :amount
+      # The margin that was applied to get this margin amount.
+      attr_reader :margin
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class TotalPretaxCreditAmount < Stripe::StripeObject
       # The amount, in cents (or local equivalent), of the pretax credit amount.
       attr_reader :amount
@@ -756,6 +895,8 @@ module Stripe
       attr_reader :credit_balance_transaction
       # The discount that was applied to get this pretax credit amount.
       attr_reader :discount
+      # The margin that was applied to get this pretax credit amount.
+      attr_reader :margin
       # Type of the pretax credit amount referenced.
       attr_reader :type
 
@@ -818,6 +959,8 @@ module Stripe
     attr_reader :amount_remaining
     # This is the sum of all the shipping amounts.
     attr_reader :amount_shipping
+    # List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
+    attr_reader :amounts_due
     # ID of the Connect Application that created the invoice.
     attr_reader :application
     # Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
@@ -852,6 +995,8 @@ module Stripe
     attr_reader :custom_fields
     # The ID of the customer who will be billed.
     attr_reader :customer
+    # The ID of the account who will be billed.
+    attr_reader :customer_account
     # The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
     attr_reader :customer_address
     # The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
@@ -866,6 +1011,8 @@ module Stripe
     attr_reader :customer_tax_exempt
     # The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
     attr_reader :customer_tax_ids
+    # The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
+    attr_reader :default_margins
     # ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
     attr_reader :default_payment_method
     # ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
@@ -956,6 +1103,8 @@ module Stripe
     attr_reader :total_discount_amounts
     # The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
     attr_reader :total_excluding_tax
+    # The aggregate amounts calculated per margin across all line items.
+    attr_reader :total_margin_amounts
     # Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
     attr_reader :total_pretax_credit_amounts
     # The aggregate tax information of all line items.
@@ -1244,6 +1393,7 @@ module Stripe
 
     def self.inner_class_types
       @inner_class_types = {
+        amounts_due: AmountsDue,
         automatic_tax: AutomaticTax,
         confirmation_secret: ConfirmationSecret,
         custom_fields: CustomField,
@@ -1261,6 +1411,7 @@ module Stripe
         status_transitions: StatusTransitions,
         threshold_reason: ThresholdReason,
         total_discount_amounts: TotalDiscountAmount,
+        total_margin_amounts: TotalMarginAmount,
         total_pretax_credit_amounts: TotalPretaxCreditAmount,
         total_taxes: TotalTax,
       }