orb-billing 1.44.0 → 1.46.0

data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb

@@ -0,0 +1,692 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Webhooks
+      class SubscriptionCostExceededStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of this webhook event.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The time at which this event was created, to the second.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute payload_style
+        #   The serialization style this payload was rendered in, as configured on the
+        #   endpoint.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::PayloadStyle]
+        required :payload_style,
+                 enum: -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::PayloadStyle }
+
+        # @!attribute properties
+        #
+        #   @return [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties]
+        required :properties, -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties }
+
+        # @!attribute subscription
+        #   The subscription in a standard webhook payload: the fields readable without
+        #   to_subscription_params(), which every interval, billing period and plan phase
+        #   depends on.
+        #
+        #   @return [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription]
+        required :subscription, -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription }
+
+        # @!attribute type
+        #   The event this payload describes.
+        #
+        #   @return [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Type]
+        required :type, enum: -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Type }
+
+        # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent} for more
+        #   details.
+        #
+        #   Issued when a subscription's cost exceeds a pre-configured amount threshold.
+        #
+        #   @param id [String] The ID of this webhook event.
+        #
+        #   @param created_at [Time] The time at which this event was created, to the second.
+        #
+        #   @param payload_style [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+        #
+        #   @param properties [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties]
+        #
+        #   @param subscription [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: the fields readable without
+        #
+        #   @param type [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Type] The event this payload describes.
+
+        # The serialization style this payload was rendered in, as configured on the
+        # endpoint.
+        #
+        # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent#payload_style
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED = :expanded
+          STANDARD = :standard
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent#properties
+        class Properties < Orb::Internal::Type::BaseModel
+          # @!attribute alert_configuration
+          #   [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+          #   usage, or credit balance and trigger webhooks when a threshold is exceeded.
+          #
+          #   Alerts created through the API can be scoped to either customers or
+          #   subscriptions.
+          #
+          #   @return [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration]
+          required :alert_configuration,
+                   -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration }
+
+          # @!attribute amount_threshold
+          #
+          #   @return [String, nil]
+          required :amount_threshold, String, nil?: true
+
+          # @!attribute evaluated_amount
+          #
+          #   @return [String, nil]
+          required :evaluated_amount, String, nil?: true
+
+          # @!attribute timeframe_end
+          #
+          #   @return [Time]
+          required :timeframe_end, Time
+
+          # @!attribute timeframe_start
+          #
+          #   @return [Time]
+          required :timeframe_start, Time
+
+          # @!method initialize(alert_configuration:, amount_threshold:, evaluated_amount:, timeframe_end:, timeframe_start:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties}
+          #   for more details.
+          #
+          #   @param alert_configuration [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration] [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+          #
+          #   @param amount_threshold [String, nil]
+          #
+          #   @param evaluated_amount [String, nil]
+          #
+          #   @param timeframe_end [Time]
+          #
+          #   @param timeframe_start [Time]
+
+          # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties#alert_configuration
+          class AlertConfiguration < Orb::Internal::Type::BaseModel
+            # @!attribute id
+            #   Also referred to as alert_id in this documentation.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   The creation time of the resource in Orb.
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute currency
+            #   The name of the currency the credit balance or invoice cost is denominated in.
+            #
+            #   @return [String, nil]
+            required :currency, String, nil?: true
+
+            # @!attribute customer
+            #   The customer the alert applies to.
+            #
+            #   @return [Orb::Models::CustomerMinified, nil]
+            required :customer, -> { Orb::CustomerMinified }, nil?: true
+
+            # @!attribute enabled
+            #   Whether the alert is enabled or disabled.
+            #
+            #   @return [Boolean]
+            required :enabled, Orb::Internal::Type::Boolean
+
+            # @!attribute metric
+            #   The metric the alert applies to.
+            #
+            #   @return [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Metric, nil]
+            required :metric,
+                     -> {
+                       Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Metric
+                     },
+                     nil?: true
+
+            # @!attribute plan
+            #   The plan the alert applies to.
+            #
+            #   @return [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Plan, nil]
+            required :plan,
+                     -> {
+                       Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Plan
+                     },
+                     nil?: true
+
+            # @!attribute subscription
+            #   The subscription the alert applies to.
+            #
+            #   @return [Orb::Models::SubscriptionMinified, nil]
+            required :subscription, -> { Orb::SubscriptionMinified }, nil?: true
+
+            # @!attribute thresholds
+            #   The thresholds that define the conditions under which the alert will be
+            #   triggered.
+            #
+            #   @return [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Threshold>, nil]
+            required :thresholds,
+                     -> {
+                       Orb::Internal::Type::ArrayOf[Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Threshold]
+                     },
+                     nil?: true
+
+            # @!attribute type
+            #   The type of alert. This must be a valid alert type.
+            #
+            #   @return [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Type]
+            required :type,
+                     enum: -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Type }
+
+            # @!attribute balance_alert_status
+            #   The current status of the alert. This field is only present for credit balance
+            #   alerts.
+            #
+            #   @return [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus>, nil]
+            optional :balance_alert_status,
+                     -> do
+                       Orb::Internal::Type::ArrayOf[
+                         Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus
+                       ]
+                     end,
+                     nil?: true
+
+            # @!attribute grouping_keys
+            #   The property keys to group cost alerts by. Only present for cost alerts with
+            #   grouping enabled.
+            #
+            #   @return [Array<String>, nil]
+            optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+            # @!attribute license_type
+            #   Minified license type for alert serialization.
+            #
+            #   @return [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::LicenseType, nil]
+            optional :license_type,
+                     -> {
+                       Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::LicenseType
+                     },
+                     nil?: true
+
+            # @!attribute price_filters
+            #   Filters scoping which prices are included in spend and grouped cost alert
+            #   evaluation. Alerts use the price_id, item_id, and price_type fields only; the
+            #   alert's pricing unit is reported by currency.
+            #
+            #   @return [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter>, nil]
+            optional :price_filters,
+                     -> {
+                       Orb::Internal::Type::ArrayOf[Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter]
+                     },
+                     nil?: true
+
+            # @!attribute threshold_overrides
+            #   Per-group threshold overrides. Each override maps a specific combination of
+            #   grouping_keys values to a replacement threshold list. Only present for grouped
+            #   cost alerts that have at least one override.
+            #
+            #   @return [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride>, nil]
+            optional :threshold_overrides,
+                     -> do
+                       Orb::Internal::Type::ArrayOf[
+                         Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride
+                       ]
+                     end,
+                     nil?: true
+
+            # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, balance_alert_status: nil, grouping_keys: nil, license_type: nil, price_filters: nil, threshold_overrides: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration}
+            #   for more details.
+            #
+            #   [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+            #   usage, or credit balance and trigger webhooks when a threshold is exceeded.
+            #
+            #   Alerts created through the API can be scoped to either customers or
+            #   subscriptions.
+            #
+            #   @param id [String] Also referred to as alert_id in this documentation.
+            #
+            #   @param created_at [Time] The creation time of the resource in Orb.
+            #
+            #   @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in.
+            #
+            #   @param customer [Orb::Models::CustomerMinified, nil] The customer the alert applies to.
+            #
+            #   @param enabled [Boolean] Whether the alert is enabled or disabled.
+            #
+            #   @param metric [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Metric, nil] The metric the alert applies to.
+            #
+            #   @param plan [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Plan, nil] The plan the alert applies to.
+            #
+            #   @param subscription [Orb::Models::SubscriptionMinified, nil] The subscription the alert applies to.
+            #
+            #   @param thresholds [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
+            #
+            #   @param type [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Type] The type of alert. This must be a valid alert type.
+            #
+            #   @param balance_alert_status [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus>, nil] The current status of the alert. This field is only present for credit balance a
+            #
+            #   @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only present for cost alerts with gro
+            #
+            #   @param license_type [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::LicenseType, nil] Minified license type for alert serialization.
+            #
+            #   @param price_filters [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter>, nil] Filters scoping which prices are included in spend and grouped cost alert evalua
+            #
+            #   @param threshold_overrides [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
+
+            # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration#metric
+            class Metric < Orb::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!method initialize(id:)
+              #   The metric the alert applies to.
+              #
+              #   @param id [String]
+            end
+
+            # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration#plan
+            class Plan < Orb::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String, nil]
+              required :id, String, nil?: true
+
+              # @!attribute external_plan_id
+              #   An optional user-defined ID for this plan resource, used throughout the system
+              #   as an alias for this Plan. Use this field to identify a plan by an existing
+              #   identifier in your system.
+              #
+              #   @return [String, nil]
+              required :external_plan_id, String, nil?: true
+
+              # @!attribute name
+              #
+              #   @return [String, nil]
+              required :name, String, nil?: true
+
+              # @!attribute plan_version
+              #
+              #   @return [String]
+              required :plan_version, String
+
+              # @!method initialize(id:, external_plan_id:, name:, plan_version:)
+              #   Some parameter documentations has been truncated, see
+              #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Plan}
+              #   for more details.
+              #
+              #   The plan the alert applies to.
+              #
+              #   @param id [String, nil]
+              #
+              #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+              #
+              #   @param name [String, nil]
+              #
+              #   @param plan_version [String]
+            end
+
+            class Threshold < Orb::Internal::Type::BaseModel
+              # @!attribute value
+              #   The value at which an alert will fire. For credit balance alerts, the alert will
+              #   fire at or below this value. For usage and cost alerts, the alert will fire at
+              #   or above this value.
+              #
+              #   @return [String]
+              required :value, String
+
+              # @!method initialize(value:)
+              #   Some parameter documentations has been truncated, see
+              #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::Threshold}
+              #   for more details.
+              #
+              #   Thresholds are used to define the conditions under which an alert will be
+              #   triggered.
+              #
+              #   @param value [String] The value at which an alert will fire. For credit balance alerts, the alert will
+            end
+
+            # The type of alert. This must be a valid alert type.
+            #
+            # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration#type
+            module Type
+              extend Orb::Internal::Type::Enum
+
+              CREDIT_BALANCE_DEPLETED = :credit_balance_depleted
+              CREDIT_BALANCE_DROPPED = :credit_balance_dropped
+              CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
+              USAGE_EXCEEDED = :usage_exceeded
+              COST_EXCEEDED = :cost_exceeded
+              SPEND_EXCEEDED = :spend_exceeded
+              LICENSE_BALANCE_THRESHOLD_REACHED = :license_balance_threshold_reached
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            class BalanceAlertStatus < Orb::Internal::Type::BaseModel
+              # @!attribute in_alert
+              #   Whether the alert is currently in-alert or not.
+              #
+              #   @return [Boolean]
+              required :in_alert, Orb::Internal::Type::Boolean
+
+              # @!attribute threshold_value
+              #   The value of the threshold that defines the alert status.
+              #
+              #   @return [String]
+              required :threshold_value, String
+
+              # @!method initialize(in_alert:, threshold_value:)
+              #   Alert status is used to determine if an alert is currently in-alert or not.
+              #
+              #   @param in_alert [Boolean] Whether the alert is currently in-alert or not.
+              #
+              #   @param threshold_value [String] The value of the threshold that defines the alert status.
+            end
+
+            # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration#license_type
+            class LicenseType < Orb::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!method initialize(id:)
+              #   Minified license type for alert serialization.
+              #
+              #   @param id [String]
+            end
+
+            class PriceFilter < Orb::Internal::Type::BaseModel
+              # @!attribute field
+              #   The property of the price to filter on.
+              #
+              #   @return [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field]
+              required :field,
+                       enum: -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field }
+
+              # @!attribute operator
+              #   Should prices that match the filter be included or excluded.
+              #
+              #   @return [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator]
+              required :operator,
+                       enum: -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator }
+
+              # @!attribute values
+              #   The IDs or values that match this filter.
+              #
+              #   @return [Array<String>]
+              required :values, Orb::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(field:, operator:, values:)
+              #   @param field [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field] The property of the price to filter on.
+              #
+              #   @param operator [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator] Should prices that match the filter be included or excluded.
+              #
+              #   @param values [Array<String>] The IDs or values that match this filter.
+
+              # The property of the price to filter on.
+              #
+              # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter#field
+              module Field
+                extend Orb::Internal::Type::Enum
+
+                PRICE_ID = :price_id
+                ITEM_ID = :item_id
+                PRICE_TYPE = :price_type
+                CURRENCY = :currency
+                PRICING_UNIT_ID = :pricing_unit_id
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # Should prices that match the filter be included or excluded.
+              #
+              # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter#operator
+              module Operator
+                extend Orb::Internal::Type::Enum
+
+                INCLUDES = :includes
+                EXCLUDES = :excludes
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class ThresholdOverride < Orb::Internal::Type::BaseModel
+              # @!attribute group_values
+              #   The values identifying this group, ordered to match group_keys when set and the
+              #   alert's grouping_keys otherwise.
+              #
+              #   @return [Array<String>]
+              required :group_values, Orb::Internal::Type::ArrayOf[String]
+
+              # @!attribute thresholds
+              #   The thresholds applied to this group. An empty list means the group is silenced.
+              #
+              #   @return [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold>]
+              required :thresholds,
+                       -> do
+                         Orb::Internal::Type::ArrayOf[
+                           Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold
+                         ]
+                       end
+
+              # @!attribute group_keys
+              #   The subset of the alert's grouping_keys this override binds. Null when the
+              #   override targets one exact group across every grouping key.
+              #
+              #   @return [Array<String>, nil]
+              optional :group_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+              # @!method initialize(group_values:, thresholds:, group_keys: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride}
+              #   for more details.
+              #
+              #   A per-group threshold override on a grouped cost alert.
+              #
+              #   An empty `thresholds` list means the group is silenced (never fires). A
+              #   non-empty list fully replaces the default thresholds for that group.
+              #
+              #   @param group_values [Array<String>] The values identifying this group, ordered to match group_keys when set and the
+              #
+              #   @param thresholds [Array<Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold>] The thresholds applied to this group. An empty list means the group is silenced.
+              #
+              #   @param group_keys [Array<String>, nil] The subset of the alert's grouping_keys this override binds. Null when the overr
+
+              class Threshold < Orb::Internal::Type::BaseModel
+                # @!attribute value
+                #   The value at which an alert will fire. For credit balance alerts, the alert will
+                #   fire at or below this value. For usage and cost alerts, the alert will fire at
+                #   or above this value.
+                #
+                #   @return [String]
+                required :value, String
+
+                # @!method initialize(value:)
+                #   Some parameter documentations has been truncated, see
+                #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold}
+                #   for more details.
+                #
+                #   Thresholds are used to define the conditions under which an alert will be
+                #   triggered.
+                #
+                #   @param value [String] The value at which an alert will fire. For credit balance alerts, the alert will
+              end
+            end
+          end
+        end
+
+        # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent#subscription
+        class Subscription < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute customer
+          #
+          #   @return [Orb::Models::CustomerMinified]
+          required :customer, -> { Orb::CustomerMinified }
+
+          # @!attribute end_date
+          #   The date Orb stops billing for this subscription.
+          #
+          #   @return [Time, nil]
+          required :end_date, Time, nil?: true
+
+          # @!attribute metadata
+          #   User specified key-value pairs for the resource. If not present, this defaults
+          #   to an empty dictionary. Individual keys can be removed by setting the value to
+          #   `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+          #   `null`.
+          #
+          #   @return [Hash{Symbol=>String}]
+          required :metadata, Orb::Internal::Type::HashOf[String]
+
+          # @!attribute name
+          #   The name of the subscription.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute plan
+          #
+          #   @return [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription::Plan, nil]
+          required :plan,
+                   -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription::Plan },
+                   nil?: true
+
+          # @!attribute start_date
+          #   The date Orb starts billing for this subscription.
+          #
+          #   @return [Time]
+          required :start_date, Time
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription::Status]
+          required :status,
+                   enum: -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription::Status }
+
+          # @!method initialize(id:, created_at:, customer:, end_date:, metadata:, name:, plan:, start_date:, status:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription}
+          #   for more details.
+          #
+          #   The subscription in a standard webhook payload: the fields readable without
+          #   to_subscription_params(), which every interval, billing period and plan phase
+          #   depends on.
+          #
+          #   @param id [String]
+          #
+          #   @param created_at [Time]
+          #
+          #   @param customer [Orb::Models::CustomerMinified]
+          #
+          #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
+          #
+          #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+          #
+          #   @param name [String] The name of the subscription.
+          #
+          #   @param plan [Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription::Plan, nil]
+          #
+          #   @param start_date [Time] The date Orb starts billing for this subscription.
+          #
+          #   @param status [Symbol, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription::Status]
+
+          # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription#plan
+          class Plan < Orb::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            required :id, String, nil?: true
+
+            # @!attribute external_plan_id
+            #   An optional user-defined ID for this plan resource, used throughout the system
+            #   as an alias for this Plan. Use this field to identify a plan by an existing
+            #   identifier in your system.
+            #
+            #   @return [String, nil]
+            required :external_plan_id, String, nil?: true
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            required :name, String, nil?: true
+
+            # @!method initialize(id:, external_plan_id:, name:)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription::Plan}
+            #   for more details.
+            #
+            #   @param id [String, nil]
+            #
+            #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+            #
+            #   @param name [String, nil]
+          end
+
+          # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription#status
+          module Status
+            extend Orb::Internal::Type::Enum
+
+            ACTIVE = :active
+            ENDED = :ended
+            UPCOMING = :upcoming
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # The event this payload describes.
+        #
+        # @see Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent#type
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          SUBSCRIPTION_COST_EXCEEDED = :"subscription.cost_exceeded"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end