stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/resources/balance_settings.rb

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Options for customizing account balances and payout settings for a Stripe platform's connected accounts.
+  class BalanceSettings < SingletonAPIResource
+    include Stripe::APIOperations::SingletonSave
+
+    OBJECT_NAME = "balance_settings"
+    def self.object_name
+      "balance_settings"
+    end
+
+    class Payments < ::Stripe::StripeObject
+      class Payouts < ::Stripe::StripeObject
+        class Schedule < ::Stripe::StripeObject
+          # How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
+          attr_reader :interval
+          # The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
+          attr_reader :monthly_payout_days
+          # The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
+          attr_reader :weekly_payout_days
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).
+        attr_reader :minimum_balance_by_currency
+        # Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details.
+        attr_reader :schedule
+        # The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
+        attr_reader :statement_descriptor
+        # Whether the funds in this account can be paid out.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { schedule: Schedule }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class SettlementTiming < ::Stripe::StripeObject
+        # The number of days charge funds are held before becoming available.
+        attr_reader :delay_days
+        # The number of days charge funds are held before becoming available. If present, overrides the default, or minimum available, for the account.
+        attr_reader :delay_days_override
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
+      attr_reader :debit_negative_balances
+      # Settings specific to the account's payouts.
+      attr_reader :payouts
+      # Attribute for field settlement_timing
+      attr_reader :settlement_timing
+
+      def self.inner_class_types
+        @inner_class_types = { payouts: Payouts, settlement_timing: SettlementTiming }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Attribute for field payments
+    attr_reader :payments
+
+    def self.inner_class_types
+      @inner_class_types = { payments: Payments }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/balance_transaction.rb

@@ -2,9 +2,89 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Balance transactions represent funds moving through your Stripe account.
+  # Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
+  #
+  # Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types)
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "balance_transaction"
+    def self.object_name
+      "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.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/balance_transactions",
+        params: params,
+        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

@@ -2,30 +2,167 @@
 # frozen_string_literal: true
 
 module Stripe
+  # These bank accounts are payment methods on `Customer` objects.
+  #
+  # 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://docs.stripe.com/payments/bank-debits-transfers)
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "bank_account"
+    def self.object_name
+      "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 resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
+      attr_reader :currently_due
+      # Details about validation and verification failures for `due` requirements that must be resolved.
+      attr_reader :errors
+      # Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account.
+      attr_reader :past_due
+      # Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another 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 resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
+      attr_reader :currently_due
+      # Details about validation and verification failures for `due` requirements that must be resolved.
+      attr_reader :errors
+      # Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account.
+      attr_reader :past_due
+      # Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another 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://docs.stripe.com/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://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    attr_reader :metadata
+    # 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`, `tokenized_account_number_deactivated` 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 the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. 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`, `verification_failed`, and `tokenized_account_number_deactivated`. 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 = {})
-      resp, opts = execute_resource_request(:post, resource_url + "/verify", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: "#{Customer.resource_url}/#{customer}/sources/#{id}/verify",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.verify(customer, id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: "#{Customer.resource_url}/#{customer}/sources/#{id}/verify",
+        params: params,
+        opts: opts
+      )
     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
 
     def self.update(_id, _params = nil, _opts = nil)
       raise NotImplementedError,
-            "Bank accounts cannot be updated without a customer ID or an " \
-            " account ID. Update a bank account using " \
+            "Bank accounts cannot be updated without a customer ID or an  " \
+            "account ID. Update a bank account using " \
             "`Customer.update_source('customer_id', 'bank_account_id', " \
             "update_params)` or `Account.update_external_account(" \
             "'account_id', 'bank_account_id', update_params)`"
@@ -39,5 +176,39 @@ module Stripe
             "or `Account.retrieve_external_account('account_id', " \
             "'bank_account_id')`"
     end
+
+    def self.delete(id, params = {}, opts = {})
+      raise NotImplementedError,
+            "Bank accounts cannot be deleted without a customer ID or an " \
+            "account ID. Delete a bank account using " \
+            "`Customer.delete_source('customer_id', 'bank_account_id')` " \
+            "or `Account.delete_external_account('account_id', " \
+            "'bank_account_id')`"
+    end
+
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: resource_url.to_s,
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list(params = {}, opts = {})
+      raise NotImplementedError,
+            "Bank accounts cannot be listed without a customer ID or an " \
+            "account ID. List bank accounts using " \
+            "`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

@@ -0,0 +1,142 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # 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.
+    class Alert < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "billing.alert"
+      def self.object_name
+        "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://docs.stripe.com/api/billing/meter).
+      attr_reader :usage_threshold
+
+      # Reactivates this alert, allowing it to trigger again.
+      def activate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/activate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Reactivates this alert, allowing it to trigger again.
+      def self.activate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/activate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
+      def archive(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/archive", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
+      def self.archive(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/archive", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a billing alert
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/billing/alerts", params: params, opts: opts)
+      end
+
+      # Deactivates this alert, preventing it from triggering.
+      def deactivate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/deactivate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deactivates this alert, preventing it from triggering.
+      def self.deactivate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Lists billing active and inactive alerts
+      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/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