stripe 17.1.0 → 17.2.0.pre.beta.1

data/lib/stripe/resources/account_notice.rb

@@ -0,0 +1,94 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
+  #
+  # See the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
+  class AccountNotice < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "account_notice"
+    def self.object_name
+      "account_notice"
+    end
+
+    class Email < ::Stripe::StripeObject
+      # Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
+      attr_reader :plain_text
+      # Email address of the recipient.
+      attr_reader :recipient
+      # Subject of the email.
+      attr_reader :subject
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class LinkedObjects < ::Stripe::StripeObject
+      # Associated [Capability](https://stripe.com/docs/api/capabilities)
+      attr_reader :capability
+      # Associated [Credit Underwriting Record](https://stripe.com/docs/api/issuing/credit_underwriting_record)
+      attr_reader :issuing_credit_underwriting_record
+      # Associated [Issuing Dispute](https://stripe.com/docs/api/issuing/disputes)
+      attr_reader :issuing_dispute
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # When present, the deadline for sending the notice to meet the relevant regulations.
+    attr_reader :deadline
+    # Information about the email when sent.
+    attr_reader :email
+    # Unique identifier for the object.
+    attr_reader :id
+    # Information about objects related to the notice.
+    attr_reader :linked_objects
+    # 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.
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
+    attr_reader :reason
+    # Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.
+    attr_reader :sent_at
+
+    # Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/account_notices", params: params, opts: opts)
+    end
+
+    # Updates an AccountNotice object.
+    def self.update(account_notice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/account_notices/%<account_notice>s", { account_notice: CGI.escape(account_notice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { email: Email, linked_objects: LinkedObjects }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/account_session.rb

@@ -111,6 +111,78 @@ module Stripe
         end
       end
 
+      class CapitalFinancing < ::Stripe::StripeObject
+        class Features < ::Stripe::StripeObject
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether the embedded component is enabled.
+        attr_reader :enabled
+        # Attribute for field features
+        attr_reader :features
+
+        def self.inner_class_types
+          @inner_class_types = { features: Features }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class CapitalFinancingApplication < ::Stripe::StripeObject
+        class Features < ::Stripe::StripeObject
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether the embedded component is enabled.
+        attr_reader :enabled
+        # Attribute for field features
+        attr_reader :features
+
+        def self.inner_class_types
+          @inner_class_types = { features: Features }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class CapitalFinancingPromotion < ::Stripe::StripeObject
+        class Features < ::Stripe::StripeObject
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether the embedded component is enabled.
+        attr_reader :enabled
+        # Attribute for field features
+        attr_reader :features
+
+        def self.inner_class_types
+          @inner_class_types = { features: Features }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class DisputesList < ::Stripe::StripeObject
         class Features < ::Stripe::StripeObject
           # Whether to allow capturing and cancelling payment intents. This is `true` by default.
@@ -589,6 +661,12 @@ module Stripe
       attr_reader :account_onboarding
       # Attribute for field balances
       attr_reader :balances
+      # Attribute for field capital_financing
+      attr_reader :capital_financing
+      # Attribute for field capital_financing_application
+      attr_reader :capital_financing_application
+      # Attribute for field capital_financing_promotion
+      attr_reader :capital_financing_promotion
       # Attribute for field disputes_list
       attr_reader :disputes_list
       # Attribute for field documents
@@ -627,6 +705,9 @@ module Stripe
           account_management: AccountManagement,
           account_onboarding: AccountOnboarding,
           balances: Balances,
+          capital_financing: CapitalFinancing,
+          capital_financing_application: CapitalFinancingApplication,
+          capital_financing_promotion: CapitalFinancingPromotion,
           disputes_list: DisputesList,
           documents: Documents,
           financial_account: FinancialAccount,

data/lib/stripe/resources/billing/analytics/meter_usage.rb

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    module Analytics
+      # A billing meter usage event represents an aggregated view of a customer's billing meter events within a specified timeframe.
+      class MeterUsage < SingletonAPIResource
+        OBJECT_NAME = "billing.analytics.meter_usage"
+        def self.object_name
+          "billing.analytics.meter_usage"
+        end
+
+        # 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
+        # The timestamp to indicate data freshness, measured in seconds since the Unix epoch.
+        attr_reader :refreshed_at
+        # Attribute for field rows
+        attr_reader :rows
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/analytics/meter_usage_row.rb

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    module Analytics
+      class MeterUsageRow < APIResource
+        OBJECT_NAME = "billing.analytics.meter_usage_row"
+        def self.object_name
+          "billing.analytics.meter_usage_row"
+        end
+
+        # A set of key-value pairs representing the dimensions of the meter usage.
+        attr_reader :dimensions
+        # Timestamp indicating the end of the bucket. Measured in seconds since the Unix epoch.
+        attr_reader :ends_at
+        # Unique identifier for the object.
+        attr_reader :id
+        # The unique identifier for the meter. Null if no meters were provided and usage was aggregated across all meters.
+        attr_reader :meter
+        # String representing the object's type. Objects of the same type share the same value.
+        attr_reader :object
+        # Timestamp indicating the start of the bucket. Measured in seconds since the Unix epoch.
+        attr_reader :starts_at
+        # The aggregated meter usage value for the specified bucket.
+        attr_reader :value
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/credit_balance_summary.rb

@@ -85,6 +85,8 @@ module Stripe
       attr_reader :balances
       # The customer the balance is for.
       attr_reader :customer
+      # The account the balance is for.
+      attr_reader :customer_account
       # 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.

data/lib/stripe/resources/billing/credit_grant.rb

@@ -93,6 +93,8 @@ module Stripe
       attr_reader :created
       # ID of the customer receiving the billing credits.
       attr_reader :customer
+      # ID of the account receiving the billing credits
+      attr_reader :customer_account
       # The time when the billing credits become effective-when they're eligible for use.
       attr_reader :effective_at
       # The time when the billing credits expire. If not present, the billing credits don't expire.

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

@@ -199,6 +199,8 @@ module Stripe
       attr_reader :created
       # The ID of the customer for this session.
       attr_reader :customer
+      # The ID of the account for this session.
+      attr_reader :customer_account
       # 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.
       attr_reader :flow
       # Unique identifier for the object.

data/lib/stripe/resources/capital/financing_offer.rb

@@ -0,0 +1,142 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing an offer of financing from
+    # Stripe Capital to a Connect subaccount.
+    class FinancingOffer < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_offer"
+      def self.object_name
+        "capital.financing_offer"
+      end
+
+      class AcceptedTerms < ::Stripe::StripeObject
+        # Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :advance_amount
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        attr_reader :currency
+        # Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+        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.
+        attr_reader :previous_financing_fee_discount_amount
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        attr_reader :withhold_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class OfferedTerms < ::Stripe::StripeObject
+        # Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :advance_amount
+        # Describes the type of user the offer is being extended to.
+        attr_reader :campaign_type
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        attr_reader :currency
+        # Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+        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.
+        attr_reader :previous_financing_fee_discount_rate
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        attr_reader :withhold_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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.
+      attr_reader :accepted_terms
+      # The ID of the merchant associated with this financing object.
+      attr_reader :account
+      # The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
+      attr_reader :charged_off_at
+      # Time at which the offer was created. Given in seconds since unix epoch.
+      attr_reader :created
+      # Time at which the offer expires. Given in seconds since unix epoch.
+      attr_reader :expires_after
+      # The type of financing being offered.
+      attr_reader :financing_type
+      # A unique identifier for the financing 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
+      # 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.
+      attr_reader :metadata
+      # The object type: financing_offer.
+      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.
+      attr_reader :offered_terms
+      # Financing product identifier.
+      attr_reader :product_type
+      # The ID of the financing offer that replaced this offer.
+      attr_reader :replacement
+      # The ID of the financing offer that this offer is a replacement for.
+      attr_reader :replacement_for
+      # The current status of the offer.
+      attr_reader :status
+      # See [financing_type](https://stripe.com/docs/api/capital/connect_financing_object#financing_offer_object-financing_type).
+      attr_reader :type
+
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def mark_delivered(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def self.mark_delivered(financing_offer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { accepted_terms: AcceptedTerms, offered_terms: OfferedTerms }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/capital/financing_summary.rb

@@ -0,0 +1,79 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # A financing object describes an account's current financing state. Used by Connect
+    # platforms to read the state of Capital offered to their connected accounts.
+    class FinancingSummary < SingletonAPIResource
+      OBJECT_NAME = "capital.financing_summary"
+      def self.object_name
+        "capital.financing_summary"
+      end
+
+      class Details < ::Stripe::StripeObject
+        class CurrentRepaymentInterval < ::Stripe::StripeObject
+          # The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
+          # Given in seconds since unix epoch.
+          attr_reader :due_at
+          # The amount that has already been paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
+          attr_reader :paid_amount
+          # The amount that is yet to be paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.
+          attr_reader :remaining_amount
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Amount of financing offered, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :advance_amount
+        # The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
+        attr_reader :advance_paid_out_at
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        attr_reader :currency
+        # The chronologically current repayment interval for the financing offer.
+        attr_reader :current_repayment_interval
+        # Fixed fee amount, in minor units. For example, $100 USD will be represented as 10000.
+        attr_reader :fee_amount
+        # The amount the Connected account has paid toward the financing debt so far, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :paid_amount
+        # The balance remaining to be paid on the financing, in minor units. For example, $1,000 USD will be represented as 100000.
+        attr_reader :remaining_amount
+        # The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
+        attr_reader :repayments_begin_at
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        attr_reader :withhold_rate
+
+        def self.inner_class_types
+          @inner_class_types = { current_repayment_interval: CurrentRepaymentInterval }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Additional information about the financing summary. Describes currency, advance amount,
+      # fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
+      # repayment start date, and advance payout date.
+      attr_reader :details
+      # The Financing Offer ID this Financing Summary corresponds to
+      attr_reader :financing_offer
+      # The object type: financing_summary
+      attr_reader :object
+      # Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
+      attr_reader :status
+
+      def self.inner_class_types
+        @inner_class_types = { details: Details }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/capital/financing_transaction.rb

@@ -0,0 +1,99 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing the details of a transaction on a Capital financing object.
+    class FinancingTransaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_transaction"
+      def self.object_name
+        "capital.financing_transaction"
+      end
+
+      class Details < ::Stripe::StripeObject
+        class Transaction < ::Stripe::StripeObject
+          # The linked payment ID.
+          attr_reader :charge
+          # The linked Treasury Financing Transaction ID.
+          attr_reader :treasury_transaction
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The advance amount being repaid, paid out, or reversed in minor units.
+        attr_reader :advance_amount
+        # The currency of the financing transaction.
+        attr_reader :currency
+        # The fee amount being repaid, paid out, or reversed in minor units.
+        attr_reader :fee_amount
+        # The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
+        attr_reader :linked_payment
+        # The reason for the financing transaction (if applicable).
+        attr_reader :reason
+        # The reversed transaction. This field only applies to financing
+        # transactions of type `reversal`.
+        attr_reader :reversed_transaction
+        # The advance and fee amount being repaid, paid out, or reversed in minor units.
+        attr_reader :total_amount
+        # This is an object representing a linked transaction on a Capital Financing Transaction.
+        attr_reader :transaction
+
+        def self.inner_class_types
+          @inner_class_types = { transaction: Transaction }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The ID of the merchant associated with this financing transaction.
+      attr_reader :account
+      # Time at which the financing transaction was created. Given in seconds since unix epoch.
+      attr_reader :created_at
+      # This is an object representing a transaction on a Capital financing offer.
+      attr_reader :details
+      # The Capital financing offer for this financing transaction.
+      attr_reader :financing_offer
+      # A unique identifier for the financing transaction object.
+      attr_reader :id
+      # The Capital transaction object that predates the Financing Transactions API and
+      # corresponds with the balance transaction that was created as a result of this
+      # financing transaction.
+      attr_reader :legacy_balance_transaction_source
+      # 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 object type: financing_transaction
+      attr_reader :object
+      # The type of the financing transaction.
+      attr_reader :type
+      # A human-friendly description of the financing transaction.
+      attr_reader :user_facing_description
+
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { details: Details }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/card.rb

@@ -53,6 +53,8 @@ module Stripe
     attr_reader :available_payout_methods
     # Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
     attr_reader :brand
+    # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+    attr_reader :brand_product
     # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
     attr_reader :country
     # Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.

data/lib/stripe/resources/cash_balance.rb

@@ -27,6 +27,8 @@ module Stripe
     attr_reader :available
     # The ID of the customer whose cash balance this object represents.
     attr_reader :customer
+    # The ID of the account whose cash balance this object represents.
+    attr_reader :customer_account
     # 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.