stripe 18.0.0 → 18.1.0.pre.alpha.1

data/lib/stripe/resources/balance_transfer.rb

@@ -0,0 +1,139 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Balance transfers represent funds moving between balance types on your Stripe account.
+  # They currently support moving funds between your Stripe balance and your [Issuing](https://stripe.com/docs/issuing) balance and between your [Allocated Funds](https://stripe.com/docs/connect/funds-segregation) balance and your Stripe balance.
+  class BalanceTransfer < APIResource
+    extend Stripe::APIOperations::Create
+
+    OBJECT_NAME = "balance_transfer"
+    def self.object_name
+      "balance_transfer"
+    end
+
+    class DestinationBalance < ::Stripe::StripeObject
+      class Issuing < ::Stripe::StripeObject
+        # Identifier for the balance_transaction that increased the destination balance.
+        attr_reader :balance_transaction
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Payments < ::Stripe::StripeObject
+        # Identifier for the balance_transaction that increased the destination balance.
+        attr_reader :balance_transaction
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field issuing
+      attr_reader :issuing
+      # Attribute for field payments
+      attr_reader :payments
+      # Destination balance type to adjust for the Balance Transfer. One of `payments`, `issuing`, or `allocated_funds`.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { issuing: Issuing, payments: Payments }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class SourceBalance < ::Stripe::StripeObject
+      class Issuing < ::Stripe::StripeObject
+        # Identifier for the balance_transaction that decreased the source balance.
+        attr_reader :balance_transaction
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Payments < ::Stripe::StripeObject
+        # Identifier for the balance_transaction that decreased the source balance.
+        attr_reader :balance_transaction
+        # The payments balance type that this BalanceTransfer pulled funds from. One of `card`, `fpx`, or `bank_account`.
+        attr_reader :source_type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field issuing
+      attr_reader :issuing
+      # Attribute for field payments
+      attr_reader :payments
+      # Source balance type to adjust for the Balance Transfer. One of `payments`, `issuing`, or `allocated_funds`.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { issuing: Issuing, payments: Payments }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # A positive integer representing how much was transferred in the smallest currency unit.
+    attr_reader :amount
+    # 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
+    # The balance that funds were transferred to.
+    attr_reader :destination_balance
+    # A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+    attr_reader :hosted_regulatory_receipt_url
+    # 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
+    # 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
+    # The balance that funds were transferred from. One of `card`, `fpx`, or `bank_account`.
+    attr_reader :source_balance
+
+    # Creates a balance transfer. For Issuing use cases, funds will be debited immediately from the source balance and credited to the destination balance immediately (if your account is based in the US) or next-business-day (if your account is based in the EU). For Segregated Separate Charges and Transfers use cases, funds will be debited immediately from the source balance and credited immediately to the destination balance.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: "/v1/balance_transfers",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { destination_balance: DestinationBalance, source_balance: SourceBalance }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

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

@@ -13,6 +13,105 @@ module Stripe
         "billing.alert"
       end
 
+      class CreditBalanceThreshold < ::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
+
+        class Lte < ::Stripe::StripeObject
+          class CustomPricingUnit < ::Stripe::StripeObject
+            class CustomPricingUnitDetails < ::Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              attr_reader :lookup_key
+              # 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 status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive decimal string representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          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 type of this balance. We currently only support `monetary` amounts.
+          attr_reader :balance_type
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
+          # The monetary amount.
+          attr_reader :monetary
+
+          def self.inner_class_types
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The filters allow limiting the scope of this credit balance alert. You must specify only a customer filter at this time.
+        attr_reader :filters
+        # Attribute for field lte
+        attr_reader :lte
+
+        def self.inner_class_types
+          @inner_class_types = { filters: Filter, lte: Lte }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class UsageThreshold < ::Stripe::StripeObject
         class Filter < ::Stripe::StripeObject
           # Limit the scope of the alert to this customer ID
@@ -47,6 +146,8 @@ module Stripe
       end
       # Defines the type of the alert.
       attr_reader :alert_type
+      # Encapsulates configuration of the alert to monitor billing credit balance.
+      attr_reader :credit_balance_threshold
       # 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.
@@ -131,7 +232,10 @@ module Stripe
       end
 
       def self.inner_class_types
-        @inner_class_types = { usage_threshold: UsageThreshold }
+        @inner_class_types = {
+          credit_balance_threshold: CreditBalanceThreshold,
+          usage_threshold: UsageThreshold,
+        }
       end
 
       def self.field_remappings

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

@@ -13,8 +13,14 @@ module Stripe
       attr_reader :alert
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
+      # Currency for the threshold value
+      attr_reader :currency
+      # Custom pricing unit for the threshold value
+      attr_reader :custom_pricing_unit
       # ID of customer for which the alert triggered
       attr_reader :customer
+      # External customer ID for the customer for which the alert triggered
+      attr_reader :external_customer_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.

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,40 @@
+# 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
+        # A set of key-value pairs representing the tenants of the meter usage.
+        attr_reader :tenants
+        # 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

@@ -12,6 +12,45 @@ module Stripe
 
       class Balance < ::Stripe::StripeObject
         class AvailableBalance < ::Stripe::StripeObject
+          class CustomPricingUnit < ::Stripe::StripeObject
+            class CustomPricingUnitDetails < ::Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              attr_reader :lookup_key
+              # 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 status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           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
@@ -26,13 +65,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # 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 }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings
@@ -41,6 +82,45 @@ module Stripe
         end
 
         class LedgerBalance < ::Stripe::StripeObject
+          class CustomPricingUnit < ::Stripe::StripeObject
+            class CustomPricingUnitDetails < ::Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              attr_reader :lookup_key
+              # 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 status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           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
@@ -55,13 +135,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # 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 }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings
@@ -85,6 +167,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_balance_transaction.rb

@@ -14,6 +14,45 @@ module Stripe
 
       class Credit < ::Stripe::StripeObject
         class Amount < ::Stripe::StripeObject
+          class CustomPricingUnit < ::Stripe::StripeObject
+            class CustomPricingUnitDetails < ::Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              attr_reader :lookup_key
+              # 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 status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           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
@@ -28,13 +67,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # 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 }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings
@@ -77,6 +118,45 @@ module Stripe
 
       class Debit < ::Stripe::StripeObject
         class Amount < ::Stripe::StripeObject
+          class CustomPricingUnit < ::Stripe::StripeObject
+            class CustomPricingUnitDetails < ::Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              attr_reader :lookup_key
+              # 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 status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           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
@@ -91,13 +171,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # 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 }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings