stripe 17.2.0.pre.beta.1 → 17.3.0.pre.alpha.1

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_row.rb

@@ -24,6 +24,8 @@ module Stripe
         attr_reader :starts_at
         # The aggregated meter usage value for the specified bucket.
         attr_reader :value
+        # A set of key-value pairs representing the tenants of the meter usage.
+        attr_reader :tenants
 
         def self.inner_class_types
           @inner_class_types = {}

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

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

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

@@ -17,6 +17,45 @@ module Stripe
       end
 
       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
@@ -31,13 +70,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
@@ -47,6 +88,19 @@ module Stripe
 
       class ApplicabilityConfig < ::Stripe::StripeObject
         class Scope < ::Stripe::StripeObject
+          class BillableItem < ::Stripe::StripeObject
+            # Unique identifier for the object.
+            attr_reader :id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
           class Price < ::Stripe::StripeObject
             # Unique identifier for the object.
             attr_reader :id
@@ -59,13 +113,15 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The billable items that credit grants can apply to. We currently only support metered billable items. Cannot be used in combination with `price_type` or `prices`.
+          attr_reader :billable_items
           # The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`.
           attr_reader :price_type
           # The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`.
           attr_reader :prices
 
           def self.inner_class_types
-            @inner_class_types = { prices: Price }
+            @inner_class_types = { billable_items: BillableItem, prices: Price }
           end
 
           def self.field_remappings

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

@@ -80,6 +80,8 @@ module Stripe
       attr_reader :customer_mapping
       # Attribute for field default_aggregation
       attr_reader :default_aggregation
+      # Set of keys that will be used to group meter events by.
+      attr_reader :dimension_payload_keys
       # The meter's name.
       attr_reader :display_name
       # The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.

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

@@ -15,6 +15,8 @@ module Stripe
 
       # Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.
       attr_reader :aggregated_value
+      # Key-value pairs of dimension values for event summaries with grouping on dimensions.
+      attr_reader :dimensions
       # End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
       attr_reader :end_time
       # Unique identifier for the object.

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

@@ -130,6 +130,47 @@ module Stripe
         )
       end
 
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = FinancingOffer
+        def self.resource_class
+          "FinancingOffer"
+        end
+
+        # Creates a test financing offer for a connected account.
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/capital/financing_offers",
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Refills a test financing offer for a connected account.
+        def self.refill(financing_offer, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/capital/financing_offers/%<financing_offer>s/refill", { financing_offer: CGI.escape(financing_offer) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Refills a test financing offer for a connected account.
+        def refill(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/capital/financing_offers/%<financing_offer>s/refill", { financing_offer: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+
       def self.inner_class_types
         @inner_class_types = { accepted_terms: AcceptedTerms, offered_terms: OfferedTerms }
       end

data/lib/stripe/resources/card.rb

@@ -17,6 +17,21 @@ module Stripe
       "card"
     end
 
+    class Benefits < ::Stripe::StripeObject
+      # Issuer of this benefit card
+      attr_reader :issuer
+      # Available benefit programs for this card
+      attr_reader :programs
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class Networks < ::Stripe::StripeObject
       # The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
       attr_reader :preferred
@@ -51,6 +66,8 @@ module Stripe
     attr_reader :allow_redisplay
     # A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
     attr_reader :available_payout_methods
+    # Attribute for field benefits
+    attr_reader :benefits
     # 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.)
@@ -154,7 +171,7 @@ module Stripe
     end
 
     def self.inner_class_types
-      @inner_class_types = { networks: Networks }
+      @inner_class_types = { benefits: Benefits, networks: Networks }
     end
 
     def self.field_remappings

data/lib/stripe/resources/charge.rb

@@ -471,6 +471,19 @@ module Stripe
       end
 
       class Card < ::Stripe::StripeObject
+        class Benefits < ::Stripe::StripeObject
+          # Issuer of the benefit card utilized on this payment
+          attr_reader :issuer
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class Checks < ::Stripe::StripeObject
           # If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
           attr_reader :address_line1_check
@@ -868,6 +881,8 @@ module Stripe
         attr_reader :amount_requested
         # Authorization code on the charge.
         attr_reader :authorization_code
+        # Attribute for field benefits
+        attr_reader :benefits
         # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
         attr_reader :brand
         # When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.
@@ -929,6 +944,7 @@ module Stripe
 
         def self.inner_class_types
           @inner_class_types = {
+            benefits: Benefits,
             checks: Checks,
             decremental_authorization: DecrementalAuthorization,
             extended_authorization: ExtendedAuthorization,
@@ -2451,6 +2467,8 @@ module Stripe
     attr_reader :transfer_data
     # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
     attr_reader :transfer_group
+    # Funds that are in transit and destined for another balance or another connected account.
+    attr_reader :allocated_funds
 
     # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
     #