stripe 13.4.1 → 17.0.1

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

@@ -16,6 +16,106 @@ module Stripe
         "billing.credit_grant"
       end
 
+      class Amount < Stripe::StripeObject
+        class Monetary < Stripe::StripeObject
+          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+          attr_reader :currency
+          # A positive integer representing the amount.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The monetary amount.
+        attr_reader :monetary
+        # The type of this amount. We currently only support `monetary` billing credits.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { monetary: Monetary }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ApplicabilityConfig < Stripe::StripeObject
+        class Scope < Stripe::StripeObject
+          class Price < 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
+          # 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 }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field scope
+        attr_reader :scope
+
+        def self.inner_class_types
+          @inner_class_types = { scope: Scope }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field amount
+      attr_reader :amount
+      # Attribute for field applicability_config
+      attr_reader :applicability_config
+      # The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
+      attr_reader :category
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # ID of the customer receiving the billing credits.
+      attr_reader :customer
+      # 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.
+      attr_reader :expires_at
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # 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
+      # A descriptive name shown in dashboard.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
+      attr_reader :priority
+      # ID of the test clock this credit grant belongs to.
+      attr_reader :test_clock
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+      # The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
+      attr_reader :voided_at
+
       # Creates a credit grant.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -85,6 +185,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = { amount: Amount, applicability_config: ApplicabilityConfig }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -21,6 +21,86 @@ module Stripe
                                     operations: %i[list],
                                     resource_plural: "event_summaries"
 
+      class CustomerMapping < Stripe::StripeObject
+        # The key in the meter event payload to use for mapping the event to a customer.
+        attr_reader :event_payload_key
+        # The method for mapping a meter event to a customer.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class DefaultAggregation < Stripe::StripeObject
+        # Specifies how events are aggregated.
+        attr_reader :formula
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusTransitions < Stripe::StripeObject
+        # The time the meter was deactivated, if any. Measured in seconds since Unix epoch.
+        attr_reader :deactivated_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ValueSettings < Stripe::StripeObject
+        # The key in the meter event payload to use as the value for this meter.
+        attr_reader :event_payload_key
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Attribute for field customer_mapping
+      attr_reader :customer_mapping
+      # Attribute for field default_aggregation
+      attr_reader :default_aggregation
+      # 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.
+      attr_reader :event_name
+      # The time window which meter events have been pre-aggregated for, if any.
+      attr_reader :event_time_window
+      # 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
+      # The meter's status.
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+      # Attribute for field value_settings
+      attr_reader :value_settings
+
       # Creates a billing meter.
       def self.create(params = {}, opts = {})
         request_stripe_object(method: :post, path: "/v1/billing/meters", params: params, opts: opts)
@@ -80,6 +160,19 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          customer_mapping: CustomerMapping,
+          default_aggregation: DefaultAggregation,
+          status_transitions: StatusTransitions,
+          value_settings: ValueSettings,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -12,6 +12,21 @@ module Stripe
         "billing.meter_event"
       end
 
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The name of the meter event. Corresponds with the `event_name` field on a meter.
+      attr_reader :event_name
+      # A unique identifier for the event.
+      attr_reader :identifier
+      # 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 payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+      attr_reader :payload
+      # The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.
+      attr_reader :timestamp
+
       # Creates a billing meter event.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -21,6 +36,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -12,6 +12,31 @@ module Stripe
         "billing.meter_event_adjustment"
       end
 
+      class Cancel < Stripe::StripeObject
+        # Unique identifier for the event.
+        attr_reader :identifier
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Specifies which event to cancel.
+      attr_reader :cancel
+      # The name of the meter event. Corresponds with the `event_name` field on a meter.
+      attr_reader :event_name
+      # 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 meter event adjustment's status.
+      attr_reader :status
+      # Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+      attr_reader :type
+
       # Creates a billing meter event adjustment.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -21,6 +46,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = { cancel: Cancel }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -5,11 +5,36 @@ module Stripe
   module Billing
     # A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much
     # usage was accrued by a customer for that period.
+    #
+    # Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.
     class MeterEventSummary < APIResource
       OBJECT_NAME = "billing.meter_event_summary"
       def self.object_name
         "billing.meter_event_summary"
       end
+
+      # 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
+      # End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
+      attr_reader :end_time
+      # 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
+      # The meter associated with this event summary.
+      attr_reader :meter
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.
+      attr_reader :start_time
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -14,6 +14,248 @@ module Stripe
         "billing_portal.configuration"
       end
 
+      class BusinessProfile < Stripe::StripeObject
+        # The messaging shown to customers in the portal.
+        attr_reader :headline
+        # A link to the business’s publicly available privacy policy.
+        attr_reader :privacy_policy_url
+        # A link to the business’s publicly available terms of service.
+        attr_reader :terms_of_service_url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Features < Stripe::StripeObject
+        class CustomerUpdate < Stripe::StripeObject
+          # The types of customer updates that are supported. When empty, customers are not updateable.
+          attr_reader :allowed_updates
+          # Whether the feature is enabled.
+          attr_reader :enabled
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class InvoiceHistory < Stripe::StripeObject
+          # Whether the feature is enabled.
+          attr_reader :enabled
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class PaymentMethodUpdate < Stripe::StripeObject
+          # Whether the feature is enabled.
+          attr_reader :enabled
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionCancel < Stripe::StripeObject
+          class CancellationReason < Stripe::StripeObject
+            # Whether the feature is enabled.
+            attr_reader :enabled
+            # Which cancellation reasons will be given as options to the customer.
+            attr_reader :options
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Attribute for field cancellation_reason
+          attr_reader :cancellation_reason
+          # Whether the feature is enabled.
+          attr_reader :enabled
+          # Whether to cancel subscriptions immediately or at the end of the billing period.
+          attr_reader :mode
+          # Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.
+          attr_reader :proration_behavior
+
+          def self.inner_class_types
+            @inner_class_types = { cancellation_reason: CancellationReason }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class SubscriptionUpdate < Stripe::StripeObject
+          class Product < Stripe::StripeObject
+            class AdjustableQuantity < Stripe::StripeObject
+              # If true, the quantity can be adjusted to any non-negative integer.
+              attr_reader :enabled
+              # The maximum quantity that can be set for the product.
+              attr_reader :maximum
+              # The minimum quantity that can be set for the product.
+              attr_reader :minimum
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Attribute for field adjustable_quantity
+            attr_reader :adjustable_quantity
+            # The list of price IDs which, when subscribed to, a subscription can be updated.
+            attr_reader :prices
+            # The product ID.
+            attr_reader :product
+
+            def self.inner_class_types
+              @inner_class_types = { adjustable_quantity: AdjustableQuantity }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ScheduleAtPeriodEnd < Stripe::StripeObject
+            class Condition < Stripe::StripeObject
+              # The type of condition.
+              attr_reader :type
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # List of conditions. When any condition is true, an update will be scheduled at the end of the current period.
+            attr_reader :conditions
+
+            def self.inner_class_types
+              @inner_class_types = { conditions: Condition }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
+          attr_reader :default_allowed_updates
+          # Whether the feature is enabled.
+          attr_reader :enabled
+          # The list of up to 10 products that support subscription updates.
+          attr_reader :products
+          # Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.
+          attr_reader :proration_behavior
+          # Attribute for field schedule_at_period_end
+          attr_reader :schedule_at_period_end
+          # Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation.
+          attr_reader :trial_update_behavior
+
+          def self.inner_class_types
+            @inner_class_types = { products: Product, schedule_at_period_end: ScheduleAtPeriodEnd }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field customer_update
+        attr_reader :customer_update
+        # Attribute for field invoice_history
+        attr_reader :invoice_history
+        # Attribute for field payment_method_update
+        attr_reader :payment_method_update
+        # Attribute for field subscription_cancel
+        attr_reader :subscription_cancel
+        # Attribute for field subscription_update
+        attr_reader :subscription_update
+
+        def self.inner_class_types
+          @inner_class_types = {
+            customer_update: CustomerUpdate,
+            invoice_history: InvoiceHistory,
+            payment_method_update: PaymentMethodUpdate,
+            subscription_cancel: SubscriptionCancel,
+            subscription_update: SubscriptionUpdate,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class LoginPage < Stripe::StripeObject
+        # If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.
+        #
+        # If `false`, the previously generated `url`, if any, will be deactivated.
+        attr_reader :enabled
+        # A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.
+        attr_reader :url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Whether the configuration is active and can be used to create portal sessions.
+      attr_reader :active
+      # ID of the Connect Application that created the configuration.
+      attr_reader :application
+      # Attribute for field business_profile
+      attr_reader :business_profile
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
+      attr_reader :default_return_url
+      # Attribute for field features
+      attr_reader :features
+      # Unique identifier for the object.
+      attr_reader :id
+      # Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.
+      attr_reader :is_default
+      # 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
+      # Attribute for field login_page
+      attr_reader :login_page
+      # 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 name of the configuration.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+
       # Creates a configuration that describes the functionality and behavior of a PortalSession
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -43,6 +285,18 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          business_profile: BusinessProfile,
+          features: Features,
+          login_page: LoginPage,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end