stripe 17.1.0 → 17.2.0.pre.alpha.2

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
+        # 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 = {}
+        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

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

data/lib/stripe/resources/billing/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/billing_portal/session.rb

@@ -199,6 +199,8 @@ module Stripe
       attr_reader :created
       # The ID of the customer for this session.
       attr_reader :customer
+      # The ID of the account for this session.
+      attr_reader :customer_account
       # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
       attr_reader :flow
       # Unique identifier for the object.