stripe 13.4.0 → 13.5.0.pre.beta.1

data/rbi/stripe/resources/billing_portal/session.rbi

@@ -0,0 +1,341 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module BillingPortal
+    # The Billing customer portal is a Stripe-hosted UI for subscription and
+    # billing management.
+    #
+    # A portal configuration describes the functionality and features that you
+    # want to provide to your customers through the portal.
+    #
+    # A portal session describes the instantiation of the customer portal for
+    # a particular customer. By visiting the session's URL, the customer
+    # can manage their subscriptions and billing details. For security reasons,
+    # sessions are short-lived and will expire if the customer does not visit the URL.
+    # Create sessions on-demand when customers intend to manage their subscriptions
+    # and billing details.
+    #
+    # Related guide: [Customer management](https://stripe.com/customer-management)
+    class Session < APIResource
+      class Flow < Stripe::StripeObject
+        class AfterCompletion < Stripe::StripeObject
+          class HostedConfirmation < Stripe::StripeObject
+            # A custom message to display to the customer after the flow is completed.
+            sig { returns(T.nilable(String)) }
+            attr_reader :custom_message
+          end
+          class Redirect < Stripe::StripeObject
+            # The URL the customer will be redirected to after the flow is completed.
+            sig { returns(String) }
+            attr_reader :return_url
+          end
+          # Configuration when `after_completion.type=hosted_confirmation`.
+          sig { returns(T.nilable(HostedConfirmation)) }
+          attr_reader :hosted_confirmation
+          # Configuration when `after_completion.type=redirect`.
+          sig { returns(T.nilable(Redirect)) }
+          attr_reader :redirect
+          # The specified type of behavior after the flow is completed.
+          sig { returns(String) }
+          attr_reader :type
+        end
+        class SubscriptionCancel < Stripe::StripeObject
+          class Retention < Stripe::StripeObject
+            class CouponOffer < Stripe::StripeObject
+              # The ID of the coupon to be offered.
+              sig { returns(String) }
+              attr_reader :coupon
+            end
+            # Configuration when `retention.type=coupon_offer`.
+            sig { returns(T.nilable(CouponOffer)) }
+            attr_reader :coupon_offer
+            # Type of retention strategy that will be used.
+            sig { returns(String) }
+            attr_reader :type
+          end
+          # Specify a retention strategy to be used in the cancellation flow.
+          sig { returns(T.nilable(Retention)) }
+          attr_reader :retention
+          # The ID of the subscription to be canceled.
+          sig { returns(String) }
+          attr_reader :subscription
+        end
+        class SubscriptionUpdate < Stripe::StripeObject
+          # The ID of the subscription to be updated.
+          sig { returns(String) }
+          attr_reader :subscription
+        end
+        class SubscriptionUpdateConfirm < Stripe::StripeObject
+          class Discount < Stripe::StripeObject
+            # The ID of the coupon to apply to this subscription update.
+            sig { returns(T.nilable(String)) }
+            attr_reader :coupon
+            # The ID of a promotion code to apply to this subscription update.
+            sig { returns(T.nilable(String)) }
+            attr_reader :promotion_code
+          end
+          class Item < Stripe::StripeObject
+            # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+            sig { returns(T.nilable(String)) }
+            attr_reader :id
+            # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+            sig { returns(T.nilable(String)) }
+            attr_reader :price
+            # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+            sig { returns(Integer) }
+            attr_reader :quantity
+          end
+          # The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
+          sig { returns(T.nilable(T::Array[Discount])) }
+          attr_reader :discounts
+          # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+          sig { returns(T::Array[Item]) }
+          attr_reader :items
+          # The ID of the subscription to be updated.
+          sig { returns(String) }
+          attr_reader :subscription
+        end
+        # Attribute for field after_completion
+        sig { returns(AfterCompletion) }
+        attr_reader :after_completion
+        # Configuration when `flow.type=subscription_cancel`.
+        sig { returns(T.nilable(SubscriptionCancel)) }
+        attr_reader :subscription_cancel
+        # Configuration when `flow.type=subscription_update`.
+        sig { returns(T.nilable(SubscriptionUpdate)) }
+        attr_reader :subscription_update
+        # Configuration when `flow.type=subscription_update_confirm`.
+        sig { returns(T.nilable(SubscriptionUpdateConfirm)) }
+        attr_reader :subscription_update_confirm
+        # Type of flow that the customer will go through.
+        sig { returns(String) }
+        attr_reader :type
+      end
+      # The configuration used by this session, describing the features available.
+      sig { returns(T.any(String, Stripe::BillingPortal::Configuration)) }
+      attr_reader :configuration
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      sig { returns(Integer) }
+      attr_reader :created
+      # The ID of the customer for this session.
+      sig { returns(String) }
+      attr_reader :customer
+      # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
+      sig { returns(T.nilable(Flow)) }
+      attr_reader :flow
+      # Unique identifier for the object.
+      sig { returns(String) }
+      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.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+      # The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+      # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
+      sig { returns(T.nilable(String)) }
+      attr_reader :on_behalf_of
+      # The URL to redirect customers to when they click on the portal's link to return to your website.
+      sig { returns(T.nilable(String)) }
+      attr_reader :return_url
+      # The short-lived URL of the session that gives customers access to the customer portal.
+      sig { returns(String) }
+      attr_reader :url
+      class CreateParams < Stripe::RequestParams
+        class FlowData < Stripe::RequestParams
+          class AfterCompletion < Stripe::RequestParams
+            class HostedConfirmation < Stripe::RequestParams
+              # A custom message to display to the customer after the flow is completed.
+              sig { returns(String) }
+              attr_accessor :custom_message
+              sig { params(custom_message: String).void }
+              def initialize(custom_message: nil); end
+            end
+            class Redirect < Stripe::RequestParams
+              # The URL the customer will be redirected to after the flow is completed.
+              sig { returns(String) }
+              attr_accessor :return_url
+              sig { params(return_url: String).void }
+              def initialize(return_url: nil); end
+            end
+            # Configuration when `after_completion.type=hosted_confirmation`.
+            sig {
+              returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation)
+             }
+            attr_accessor :hosted_confirmation
+            # Configuration when `after_completion.type=redirect`.
+            sig {
+              returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect)
+             }
+            attr_accessor :redirect
+            # The specified behavior after the flow is completed.
+            sig { returns(String) }
+            attr_accessor :type
+            sig {
+              params(hosted_confirmation: ::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::HostedConfirmation, redirect: ::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion::Redirect, type: String).void
+             }
+            def initialize(hosted_confirmation: nil, redirect: nil, type: nil); end
+          end
+          class SubscriptionCancel < Stripe::RequestParams
+            class Retention < Stripe::RequestParams
+              class CouponOffer < Stripe::RequestParams
+                # The ID of the coupon to be offered.
+                sig { returns(String) }
+                attr_accessor :coupon
+                sig { params(coupon: String).void }
+                def initialize(coupon: nil); end
+              end
+              # Configuration when `retention.type=coupon_offer`.
+              sig {
+                returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer)
+               }
+              attr_accessor :coupon_offer
+              # Type of retention strategy to use with the customer.
+              sig { returns(String) }
+              attr_accessor :type
+              sig {
+                params(coupon_offer: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention::CouponOffer, type: String).void
+               }
+              def initialize(coupon_offer: nil, type: nil); end
+            end
+            # Specify a retention strategy to be used in the cancellation flow.
+            sig {
+              returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention)
+             }
+            attr_accessor :retention
+            # The ID of the subscription to be canceled.
+            sig { returns(String) }
+            attr_accessor :subscription
+            sig {
+              params(retention: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel::Retention, subscription: String).void
+             }
+            def initialize(retention: nil, subscription: nil); end
+          end
+          class SubscriptionUpdate < Stripe::RequestParams
+            # The ID of the subscription to be updated.
+            sig { returns(String) }
+            attr_accessor :subscription
+            sig { params(subscription: String).void }
+            def initialize(subscription: nil); end
+          end
+          class SubscriptionUpdateConfirm < Stripe::RequestParams
+            class Discount < Stripe::RequestParams
+              # The ID of the coupon to apply to this subscription update.
+              sig { returns(String) }
+              attr_accessor :coupon
+              # The ID of a promotion code to apply to this subscription update.
+              sig { returns(String) }
+              attr_accessor :promotion_code
+              sig { params(coupon: String, promotion_code: String).void }
+              def initialize(coupon: nil, promotion_code: nil); end
+            end
+            class Item < Stripe::RequestParams
+              # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+              sig { returns(String) }
+              attr_accessor :id
+              # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+              sig { returns(String) }
+              attr_accessor :price
+              # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+              sig { returns(Integer) }
+              attr_accessor :quantity
+              sig { params(id: String, price: String, quantity: Integer).void }
+              def initialize(id: nil, price: nil, quantity: nil); end
+            end
+            # The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
+            sig {
+              returns(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount])
+             }
+            attr_accessor :discounts
+            # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+            sig {
+              returns(T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item])
+             }
+            attr_accessor :items
+            # The ID of the subscription to be updated.
+            sig { returns(String) }
+            attr_accessor :subscription
+            sig {
+              params(discounts: T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Discount], items: T::Array[::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm::Item], subscription: String).void
+             }
+            def initialize(discounts: nil, items: nil, subscription: nil); end
+          end
+          # Behavior after the flow is completed.
+          sig { returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion) }
+          attr_accessor :after_completion
+          # Configuration when `flow_data.type=subscription_cancel`.
+          sig {
+            returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel)
+           }
+          attr_accessor :subscription_cancel
+          # Configuration when `flow_data.type=subscription_update`.
+          sig {
+            returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate)
+           }
+          attr_accessor :subscription_update
+          # Configuration when `flow_data.type=subscription_update_confirm`.
+          sig {
+            returns(::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm)
+           }
+          attr_accessor :subscription_update_confirm
+          # Type of flow that the customer will go through.
+          sig { returns(String) }
+          attr_accessor :type
+          sig {
+            params(after_completion: ::Stripe::BillingPortal::Session::CreateParams::FlowData::AfterCompletion, subscription_cancel: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionCancel, subscription_update: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdate, subscription_update_confirm: ::Stripe::BillingPortal::Session::CreateParams::FlowData::SubscriptionUpdateConfirm, type: String).void
+           }
+          def initialize(
+            after_completion: nil,
+            subscription_cancel: nil,
+            subscription_update: nil,
+            subscription_update_confirm: nil,
+            type: nil
+          ); end
+        end
+        # The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
+        sig { returns(String) }
+        attr_accessor :configuration
+        # The ID of an existing customer.
+        sig { returns(String) }
+        attr_accessor :customer
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+        # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
+        sig { returns(::Stripe::BillingPortal::Session::CreateParams::FlowData) }
+        attr_accessor :flow_data
+        # The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.
+        sig { returns(String) }
+        attr_accessor :locale
+        # The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
+        sig { returns(String) }
+        attr_accessor :on_behalf_of
+        # The default URL to redirect customers to when they click on the portal's link to return to your website.
+        sig { returns(String) }
+        attr_accessor :return_url
+        sig {
+          params(configuration: String, customer: String, expand: T::Array[String], flow_data: ::Stripe::BillingPortal::Session::CreateParams::FlowData, locale: String, on_behalf_of: String, return_url: String).void
+         }
+        def initialize(
+          configuration: nil,
+          customer: nil,
+          expand: nil,
+          flow_data: nil,
+          locale: nil,
+          on_behalf_of: nil,
+          return_url: nil
+        ); end
+      end
+      # Creates a session of the customer portal.
+      sig {
+        params(params: T.any(::Stripe::BillingPortal::Session::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BillingPortal::Session)
+       }
+      def self.create(params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/resources/capability.rbi

@@ -0,0 +1,125 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # This is an object representing a capability for a Stripe account.
+  #
+  # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
+  class Capability < APIResource
+    class FutureRequirements < Stripe::StripeObject
+      class Alternative < Stripe::StripeObject
+        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        sig { returns(T::Array[String]) }
+        attr_reader :alternative_fields_due
+        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        sig { returns(T::Array[String]) }
+        attr_reader :original_fields_due
+      end
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        sig { returns(String) }
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        sig { returns(String) }
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        sig { returns(String) }
+        attr_reader :requirement
+      end
+      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      sig { returns(T.nilable(T::Array[Alternative])) }
+      attr_reader :alternatives
+      # Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :current_deadline
+      # Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
+      sig { returns(T::Array[String]) }
+      attr_reader :currently_due
+      # This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :disabled_reason
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      sig { returns(T::Array[Error]) }
+      attr_reader :errors
+      # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
+      sig { returns(T::Array[String]) }
+      attr_reader :eventually_due
+      # Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
+      sig { returns(T::Array[String]) }
+      attr_reader :past_due
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
+      sig { returns(T::Array[String]) }
+      attr_reader :pending_verification
+    end
+    class Requirements < Stripe::StripeObject
+      class Alternative < Stripe::StripeObject
+        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        sig { returns(T::Array[String]) }
+        attr_reader :alternative_fields_due
+        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        sig { returns(T::Array[String]) }
+        attr_reader :original_fields_due
+      end
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        sig { returns(String) }
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        sig { returns(String) }
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        sig { returns(String) }
+        attr_reader :requirement
+      end
+      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      sig { returns(T.nilable(T::Array[Alternative])) }
+      attr_reader :alternatives
+      # Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :current_deadline
+      # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
+      sig { returns(T::Array[String]) }
+      attr_reader :currently_due
+      # Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
+      sig { returns(T.nilable(String)) }
+      attr_reader :disabled_reason
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      sig { returns(T::Array[Error]) }
+      attr_reader :errors
+      # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
+      sig { returns(T::Array[String]) }
+      attr_reader :eventually_due
+      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
+      sig { returns(T::Array[String]) }
+      attr_reader :past_due
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      sig { returns(T::Array[String]) }
+      attr_reader :pending_verification
+    end
+    # The account for which the capability enables functionality.
+    sig { returns(T.any(String, Stripe::Account)) }
+    attr_reader :account
+    # Attribute for field future_requirements
+    sig { returns(FutureRequirements) }
+    attr_reader :future_requirements
+    # The identifier for the capability.
+    sig { returns(String) }
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # Whether the capability has been requested.
+    sig { returns(T::Boolean) }
+    attr_reader :requested
+    # Time at which the capability was requested. Measured in seconds since the Unix epoch.
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :requested_at
+    # Attribute for field requirements
+    sig { returns(Requirements) }
+    attr_reader :requirements
+    # The status of the capability.
+    sig { returns(String) }
+    attr_reader :status
+  end
+end

data/rbi/stripe/resources/capital/financing_offer.rbi

@@ -0,0 +1,190 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Capital
+    # This is an object representing an offer of financing from
+    # Stripe Capital to a Connect subaccount.
+    class FinancingOffer < APIResource
+      class AcceptedTerms < Stripe::StripeObject
+        # Amount of financing offered, in minor units.
+        sig { returns(Integer) }
+        attr_reader :advance_amount
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        sig { returns(String) }
+        attr_reader :currency
+        # Fixed fee amount, in minor units.
+        sig { returns(Integer) }
+        attr_reader :fee_amount
+        # Populated when the `product_type` of the `financingoffer` is `refill`.
+        # Represents the discount amount on remaining premium for the existing loan at payout time.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :previous_financing_fee_discount_amount
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        sig { returns(Float) }
+        attr_reader :withhold_rate
+      end
+      class OfferedTerms < Stripe::StripeObject
+        # Amount of financing offered, in minor units.
+        sig { returns(Integer) }
+        attr_reader :advance_amount
+        # Describes the type of user the offer is being extended to.
+        sig { returns(String) }
+        attr_reader :campaign_type
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        sig { returns(String) }
+        attr_reader :currency
+        # Fixed fee amount, in minor units.
+        sig { returns(Integer) }
+        attr_reader :fee_amount
+        # Populated when the `product_type` of the `financingoffer` is `refill`.
+        # Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
+        # is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
+        # and the remaining fee.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :previous_financing_fee_discount_rate
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        sig { returns(Float) }
+        attr_reader :withhold_rate
+      end
+      # This is an object representing the terms of an offer of financing from
+      # Stripe Capital to a Connected account. This resource represents
+      # the terms accepted by the Connected account, which may differ from those
+      # offered.
+      sig { returns(AcceptedTerms) }
+      attr_reader :accepted_terms
+      # The ID of the merchant associated with this financing object.
+      sig { returns(String) }
+      attr_reader :account
+      # The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
+      sig { returns(Integer) }
+      attr_reader :charged_off_at
+      # Time at which the offer was created. Given in seconds since unix epoch.
+      sig { returns(Integer) }
+      attr_reader :created
+      # Time at which the offer expires. Given in seconds since unix epoch.
+      sig { returns(Float) }
+      attr_reader :expires_after
+      # The type of financing being offered.
+      sig { returns(String) }
+      attr_reader :financing_type
+      # A unique identifier for the financing object.
+      sig { returns(String) }
+      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.
+      sig { returns(T::Boolean) }
+      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.
+      sig { returns(T::Hash[String, String]) }
+      attr_reader :metadata
+      # The object type: financing_offer.
+      sig { returns(String) }
+      attr_reader :object
+      # This is an object representing the terms of an offer of financing from
+      # Stripe Capital to a Connected account. This resource represents
+      # both the terms offered to the Connected account.
+      sig { returns(OfferedTerms) }
+      attr_reader :offered_terms
+      # Financing product identifier.
+      sig { returns(String) }
+      attr_reader :product_type
+      # The ID of the financing offer that replaced this offer.
+      sig { returns(String) }
+      attr_reader :replacement
+      # The ID of the financing offer that this offer is a replacement for.
+      sig { returns(String) }
+      attr_reader :replacement_for
+      # The current status of the offer.
+      sig { returns(String) }
+      attr_reader :status
+      # See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
+      sig { returns(String) }
+      attr_reader :type
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          sig { returns(Integer) }
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          sig { returns(Integer) }
+          attr_accessor :lte
+          sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+        end
+        # limit list to offers belonging to given connected account
+        sig { returns(String) }
+        attr_accessor :connected_account
+        # Only return offers that were created during the given date interval.
+        sig { returns(T.any(::Stripe::Capital::FinancingOffer::ListParams::Created, Integer)) }
+        attr_accessor :created
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        sig { returns(String) }
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        sig { returns(Integer) }
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        sig { returns(String) }
+        attr_accessor :starting_after
+        # limit list to offers with given status
+        sig { returns(String) }
+        attr_accessor :status
+        sig {
+          params(connected_account: String, created: T.any(::Stripe::Capital::FinancingOffer::ListParams::Created, Integer), ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, status: String).void
+         }
+        def initialize(
+          connected_account: nil,
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil
+        ); end
+      end
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+      class MarkDeliveredParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      sig {
+        params(params: T.any(::Stripe::Capital::FinancingOffer::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      sig {
+        params(params: T.any(::Stripe::Capital::FinancingOffer::MarkDeliveredParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingOffer)
+       }
+      def mark_delivered(params = {}, opts = {}); end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      sig {
+        params(financing_offer: String, params: T.any(::Stripe::Capital::FinancingOffer::MarkDeliveredParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capital::FinancingOffer)
+       }
+      def self.mark_delivered(financing_offer, params = {}, opts = {}); end
+    end
+  end
+end