stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/balance_transaction.rb

@@ -14,6 +14,59 @@ module Stripe
       "balance_transaction"
     end
 
+    class FeeDetail < Stripe::StripeObject
+      # Amount of the fee, in cents.
+      attr_reader :amount
+      # ID of the Connect application that earned the fee.
+      attr_reader :application
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_reader :description
+      # Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
+    attr_reader :amount
+    # The date that the transaction's net funds become available in the Stripe balance.
+    attr_reader :available_on
+    # The balance that this transaction impacts.
+    attr_reader :balance_type
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+    attr_reader :currency
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.
+    attr_reader :exchange_rate
+    # Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.
+    attr_reader :fee
+    # Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
+    attr_reader :fee_details
+    # Unique identifier for the object.
+    attr_reader :id
+    # Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`
+    attr_reader :net
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.
+    attr_reader :reporting_category
+    # This transaction relates to the Stripe object.
+    attr_reader :source
+    # The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.
+    attr_reader :status
+    # Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
+    attr_reader :type
+
     # Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
     #
     # Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
@@ -25,5 +78,13 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = { fee_details: FeeDetail }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/bank_account.rb

@@ -4,11 +4,11 @@
 module Stripe
   # These bank accounts are payment methods on `Customer` objects.
   #
-  # On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer
+  # On the other hand [External Accounts](https://docs.stripe.com/api#external_accounts) are transfer
   # destinations on `Account` objects for connected accounts.
   # They can be bank accounts or debit cards as well, and are documented in the links above.
   #
-  # Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers)
+  # Related guide: [Bank debits and transfers](https://docs.stripe.com/payments/bank-debits-transfers)
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
@@ -19,6 +19,118 @@ module Stripe
       "bank_account"
     end
 
+    class FutureRequirements < Stripe::StripeObject
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        attr_reader :requirement
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      attr_reader :currently_due
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      attr_reader :errors
+      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
+      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.
+      attr_reader :pending_verification
+
+      def self.inner_class_types
+        @inner_class_types = { errors: Error }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Requirements < Stripe::StripeObject
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        attr_reader :requirement
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      attr_reader :currently_due
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      attr_reader :errors
+      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
+      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.
+      attr_reader :pending_verification
+
+      def self.inner_class_types
+        @inner_class_types = { errors: Error }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
+    attr_reader :account
+    # The name of the person or business that owns the bank account.
+    attr_reader :account_holder_name
+    # The type of entity that holds the account. This can be either `individual` or `company`.
+    attr_reader :account_holder_type
+    # The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
+    attr_reader :account_type
+    # A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.
+    attr_reader :available_payout_methods
+    # Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
+    attr_reader :bank_name
+    # Two-letter ISO code representing the country the bank account is located in.
+    attr_reader :country
+    # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
+    attr_reader :currency
+    # The ID of the customer that the bank account is associated with.
+    attr_reader :customer
+    # Whether this bank account is the default external account for its currency.
+    attr_reader :default_for_currency
+    # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
+    attr_reader :fingerprint
+    # Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
+    attr_reader :future_requirements
+    # Unique identifier for the object.
+    attr_reader :id
+    # The last four digits of the bank account number.
+    attr_reader :last4
+    # 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
+    # Information about the requirements for the bank account, including what information needs to be collected.
+    attr_reader :requirements
+    # The routing transit number for the bank account.
+    attr_reader :routing_number
+    # For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.
+    #
+    # For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.
+    attr_reader :status
+    # Always true for a deleted object
+    attr_reader :deleted
+
     def verify(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -38,10 +150,12 @@ module Stripe
     end
 
     def resource_url
-      if respond_to?(:customer)
+      if !customer.nil?
         "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
-      elsif respond_to?(:account)
+      elsif !account.nil?
         "#{Account.resource_url}/#{CGI.escape(account)}/external_accounts/#{CGI.escape(id)}"
+      else
+        raise InvalidRequestError, "Could not determine which URL to request: [account, customer] fields are all null"
       end
     end
 
@@ -88,5 +202,13 @@ module Stripe
             "`Customer.list_sources('customer_id')` " \
             "or `Account.list_external_accounts('account_id')`"
     end
+
+    def self.inner_class_types
+      @inner_class_types = { future_requirements: FutureRequirements, requirements: Requirements }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

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

@@ -13,6 +13,53 @@ module Stripe
         "billing.alert"
       end
 
+      class UsageThreshold < Stripe::StripeObject
+        class Filter < Stripe::StripeObject
+          # Limit the scope of the alert to this customer ID
+          attr_reader :customer
+          # Attribute for field type
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.
+        attr_reader :filters
+        # The value at which this alert will trigger.
+        attr_reader :gte
+        # The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
+        attr_reader :meter
+        # Defines how the alert will behave.
+        attr_reader :recurrence
+
+        def self.inner_class_types
+          @inner_class_types = { filters: Filter }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Defines the type of the alert.
+      attr_reader :alert_type
+      # 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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Status of the alert. This can be active, inactive or archived.
+      attr_reader :status
+      # Title of the alert.
+      attr_reader :title
+      # Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
+      attr_reader :usage_threshold
+
       # Reactivates this alert, allowing it to trigger again.
       def activate(params = {}, opts = {})
         request_stripe_object(
@@ -82,6 +129,14 @@ module Stripe
       def self.list(params = {}, opts = {})
         request_stripe_object(method: :get, path: "/v1/billing/alerts", params: params, opts: opts)
       end
+
+      def self.inner_class_types
+        @inner_class_types = { usage_threshold: UsageThreshold }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class AlertTriggered < APIResource
+      OBJECT_NAME = "billing.alert_triggered"
+      def self.object_name
+        "billing.alert_triggered"
+      end
+
+      # A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
+      attr_reader :alert
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # ID of customer for which the alert triggered
+      attr_reader :customer
+      # 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 value triggering the alert
+      attr_reader :value
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -9,6 +9,94 @@ module Stripe
       def self.object_name
         "billing.credit_balance_summary"
       end
+
+      class Balance < Stripe::StripeObject
+        class AvailableBalance < Stripe::StripeObject
+          class Monetary < Stripe::StripeObject
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class LedgerBalance < Stripe::StripeObject
+          class Monetary < Stripe::StripeObject
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field available_balance
+        attr_reader :available_balance
+        # Attribute for field ledger_balance
+        attr_reader :ledger_balance
+
+        def self.inner_class_types
+          @inner_class_types = { available_balance: AvailableBalance, ledger_balance: LedgerBalance }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.
+      attr_reader :balances
+      # The customer the balance is for.
+      attr_reader :customer
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
+      def self.inner_class_types
+        @inner_class_types = { balances: Balance }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -12,6 +12,149 @@ module Stripe
         "billing.credit_balance_transaction"
       end
 
+      class Credit < Stripe::StripeObject
+        class Amount < Stripe::StripeObject
+          class Monetary < Stripe::StripeObject
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CreditsApplicationInvoiceVoided < Stripe::StripeObject
+          # The invoice to which the reinstated billing credits were originally applied.
+          attr_reader :invoice
+          # The invoice line item to which the reinstated billing credits were originally applied.
+          attr_reader :invoice_line_item
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field amount
+        attr_reader :amount
+        # Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.
+        attr_reader :credits_application_invoice_voided
+        # The type of credit transaction.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            amount: Amount,
+            credits_application_invoice_voided: CreditsApplicationInvoiceVoided,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Debit < Stripe::StripeObject
+        class Amount < Stripe::StripeObject
+          class Monetary < Stripe::StripeObject
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CreditsApplied < Stripe::StripeObject
+          # The invoice to which the billing credits were applied.
+          attr_reader :invoice
+          # The invoice line item to which the billing credits were applied.
+          attr_reader :invoice_line_item
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field amount
+        attr_reader :amount
+        # Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.
+        attr_reader :credits_applied
+        # The type of debit transaction.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { amount: Amount, credits_applied: CreditsApplied }
+        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
+      # Credit details for this credit balance transaction. Only present if type is `credit`.
+      attr_reader :credit
+      # The credit grant associated with this credit balance transaction.
+      attr_reader :credit_grant
+      # Debit details for this credit balance transaction. Only present if type is `debit`.
+      attr_reader :debit
+      # The effective time of this credit balance transaction.
+      attr_reader :effective_at
+      # 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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # ID of the test clock this credit balance transaction belongs to.
+      attr_reader :test_clock
+      # The type of credit balance transaction (credit or debit).
+      attr_reader :type
+
       # Retrieve a list of credit balance transactions.
       def self.list(params = {}, opts = {})
         request_stripe_object(
@@ -21,6 +164,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = { credit: Credit, debit: Debit }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end