orb-billing 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8881d5c5ce3ce2170690cbd58bf18eb722b2cee0947b4678045716d63e8a0e9
-  data.tar.gz: 6d9b9c876db25a171ade9ec9631384299cece32bc5a505e24187df19b4621b4b
+  metadata.gz: 19227e347dfaaa00a58f6ad54abae076fe861aee72c03197b0270a9e17423ed1
+  data.tar.gz: 129c2a00adaad2e94eec77ad9901c9bb18668218babfe5047c92e424a460cbdc
 SHA512:
-  metadata.gz: cbc021724838465722a00f5148f8296de933ef9ea525172aa26a093c9ce2bb148dd3a85a6649e8030490721182c2c2b476b00f5739e50bfd6cfcda7c950807ef
-  data.tar.gz: b37b6815005f069aa35c06559e812669260bd3676ca12f33a92ca6e793178459851ad971c41e9d1a48a200404c4587df6ff38f183eda80ad572c7648b0203a9a
+  metadata.gz: '07380ab667d49def185a414eb23da60ddc3f347cbda0e932887779666c10da8bc0d14387fc14b70ea2dda4fa6e1e7c16a40364dfc71ca40667a6c1c51364930c'
+  data.tar.gz: 14dd81c7cda0f7c9316e24cbc4a20de7c82430b061ae8a187d6f7b6cd73a9c64caea83dbad0b45d6bcc3674da17fbcb64b4346fa1a3b1212fc963e889a1d3087

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.23.0](https://github.com/orbcorp/orb-ruby/compare/v1.22.0...v1.23.0) (2026-07-26)
+
+
+### Features
+
+* **api:** add `spend_exceeded` alert type for subscription-level alerts ([4a1374f](https://github.com/orbcorp/orb-ruby/commit/4a1374f023cc38e9d419406d91d2df5fb7a81542))
+
 ## [1.22.0](https://github.com/orbcorp/orb-ruby/compare/v1.21.0...v1.22.0) (2026-07-25)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.22.0"
+gem "orb-billing", "~> 1.23.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/alert.rb

@@ -207,6 +207,7 @@ module Orb
         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

data/lib/orb/models/alert_create_for_subscription_params.rb

@@ -25,8 +25,8 @@ module Orb
       required :type, enum: -> { Orb::AlertCreateForSubscriptionParams::Type }
 
       # @!attribute currency
-      #   The case sensitive currency or custom pricing unit to use for grouped cost
-      #   alerts. Required when grouping_keys is set.
+      #   The case sensitive currency or custom pricing unit the alert is denominated in.
+      #   Required for spend_exceeded alerts and when grouping_keys is set.
       #
       #   @return [String, nil]
       optional :currency, String, nil?: true
@@ -45,9 +45,10 @@ module Orb
       optional :metric_id, String, nil?: true
 
       # @!attribute price_filters
-      #   Filters to scope which prices are included in grouped cost alert evaluation.
-      #   Supports filtering by price_id, item_id, or price_type with includes/excludes
-      #   operators. Only applicable when grouping_keys is set.
+      #   Filters to scope which prices are included in alert evaluation. Supports
+      #   filtering by price_id, item_id, or price_type with includes/excludes operators.
+      #   Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
+      #   grouping_keys set.
       #
       #   @return [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil]
       optional :price_filters,
@@ -76,13 +77,13 @@ module Orb
       #
       #   @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
       #
-      #   @param currency [String, nil] The case sensitive currency or custom pricing unit to use for grouped cost alert
+      #   @param currency [String, nil] The case sensitive currency or custom pricing unit the alert is denominated in.
       #
       #   @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only applicable for cost_exceeded ale
       #
       #   @param metric_id [String, nil] The metric to track usage for.
       #
-      #   @param price_filters [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil] Filters to scope which prices are included in grouped cost alert evaluation. Sup
+      #   @param price_filters [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil] Filters to scope which prices are included in alert evaluation. Supports filteri
       #
       #   @param threshold_overrides [Array<Orb::Models::AlertCreateForSubscriptionParams::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
       #
@@ -94,6 +95,7 @@ module Orb
 
         USAGE_EXCEEDED = :usage_exceeded
         COST_EXCEEDED = :cost_exceeded
+        SPEND_EXCEEDED = :spend_exceeded
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/orb/resources/alerts.rb

@@ -217,15 +217,18 @@ module Orb
       #
       # This endpoint is used to create alerts at the subscription level.
       #
-      # Subscription level alerts can be one of two types: `usage_exceeded` or
-      # `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and
-      # is triggered when the usage of that metric exceeds predefined thresholds during
-      # the current billing cycle. A `cost_exceeded` alert is triggered when the total
-      # amount due during the current billing cycle surpasses predefined thresholds.
-      # `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each
+      # Subscription level alerts can be one of three types: `usage_exceeded`,
+      # `cost_exceeded`, or `spend_exceeded`. A `usage_exceeded` alert is scoped to a
+      # particular metric and is triggered when the usage of that metric exceeds
+      # predefined thresholds during the current billing cycle. A `cost_exceeded` alert
+      # is triggered when the total amount due during the current billing cycle
+      # surpasses predefined thresholds. `cost_exceeded` alerts do not include burndown
+      # of pre-purchase credits. A `spend_exceeded` alert is triggered when the rated
+      # spend (the pricing subtotal, before invoice-level adjustments and credits)
+      # denominated in the alert's currency exceeds predefined thresholds during the
+      # current billing cycle; `price_filters` can scope which prices contribute. Each
       # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
-      # per metric that is a part of the subscription. Alerts are triggered based on
-      # usage or cost conditions met during the current billing cycle.
+      # per metric that is a part of the subscription.
       #
       # @overload create_for_subscription(subscription_id, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, price_filters: nil, threshold_overrides: nil, request_options: {})
       #
@@ -235,13 +238,13 @@ module Orb
       #
       # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
       #
-      # @param currency [String, nil] The case sensitive currency or custom pricing unit to use for grouped cost alert
+      # @param currency [String, nil] The case sensitive currency or custom pricing unit the alert is denominated in.
       #
       # @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only applicable for cost_exceeded ale
       #
       # @param metric_id [String, nil] The metric to track usage for.
       #
-      # @param price_filters [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil] Filters to scope which prices are included in grouped cost alert evaluation. Sup
+      # @param price_filters [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil] Filters to scope which prices are included in alert evaluation. Supports filteri
       #
       # @param threshold_overrides [Array<Orb::Models::AlertCreateForSubscriptionParams::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
       #

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.22.0"
+  VERSION = "1.23.0"
 end

data/rbi/orb/models/alert.rbi

@@ -265,6 +265,7 @@ module Orb
           T.let(:credit_balance_recovered, Orb::Alert::Type::TaggedSymbol)
         USAGE_EXCEEDED = T.let(:usage_exceeded, Orb::Alert::Type::TaggedSymbol)
         COST_EXCEEDED = T.let(:cost_exceeded, Orb::Alert::Type::TaggedSymbol)
+        SPEND_EXCEEDED = T.let(:spend_exceeded, Orb::Alert::Type::TaggedSymbol)
         LICENSE_BALANCE_THRESHOLD_REACHED =
           T.let(
             :license_balance_threshold_reached,

data/rbi/orb/models/alert_create_for_subscription_params.rbi

@@ -22,8 +22,8 @@ module Orb
       sig { returns(Orb::AlertCreateForSubscriptionParams::Type::OrSymbol) }
       attr_accessor :type
 
-      # The case sensitive currency or custom pricing unit to use for grouped cost
-      # alerts. Required when grouping_keys is set.
+      # The case sensitive currency or custom pricing unit the alert is denominated in.
+      # Required for spend_exceeded alerts and when grouping_keys is set.
       sig { returns(T.nilable(String)) }
       attr_accessor :currency
 
@@ -36,9 +36,10 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :metric_id
 
-      # Filters to scope which prices are included in grouped cost alert evaluation.
-      # Supports filtering by price_id, item_id, or price_type with includes/excludes
-      # operators. Only applicable when grouping_keys is set.
+      # Filters to scope which prices are included in alert evaluation. Supports
+      # filtering by price_id, item_id, or price_type with includes/excludes operators.
+      # Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
+      # grouping_keys set.
       sig do
         returns(
           T.nilable(
@@ -91,17 +92,18 @@ module Orb
         thresholds:,
         # The type of alert to create. This must be a valid alert type.
         type:,
-        # The case sensitive currency or custom pricing unit to use for grouped cost
-        # alerts. Required when grouping_keys is set.
+        # The case sensitive currency or custom pricing unit the alert is denominated in.
+        # Required for spend_exceeded alerts and when grouping_keys is set.
         currency: nil,
         # The property keys to group cost alerts by. Only applicable for cost_exceeded
         # alerts.
         grouping_keys: nil,
         # The metric to track usage for.
         metric_id: nil,
-        # Filters to scope which prices are included in grouped cost alert evaluation.
-        # Supports filtering by price_id, item_id, or price_type with includes/excludes
-        # operators. Only applicable when grouping_keys is set.
+        # Filters to scope which prices are included in alert evaluation. Supports
+        # filtering by price_id, item_id, or price_type with includes/excludes operators.
+        # Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
+        # grouping_keys set.
         price_filters: nil,
         # Per-group threshold overrides. Each override maps a specific combination of
         # grouping_keys values to a list of thresholds that fully replaces the default
@@ -159,6 +161,11 @@ module Orb
             :cost_exceeded,
             Orb::AlertCreateForSubscriptionParams::Type::TaggedSymbol
           )
+        SPEND_EXCEEDED =
+          T.let(
+            :spend_exceeded,
+            Orb::AlertCreateForSubscriptionParams::Type::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/orb/resources/alerts.rbi

@@ -169,15 +169,18 @@ module Orb
 
       # This endpoint is used to create alerts at the subscription level.
       #
-      # Subscription level alerts can be one of two types: `usage_exceeded` or
-      # `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and
-      # is triggered when the usage of that metric exceeds predefined thresholds during
-      # the current billing cycle. A `cost_exceeded` alert is triggered when the total
-      # amount due during the current billing cycle surpasses predefined thresholds.
-      # `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each
+      # Subscription level alerts can be one of three types: `usage_exceeded`,
+      # `cost_exceeded`, or `spend_exceeded`. A `usage_exceeded` alert is scoped to a
+      # particular metric and is triggered when the usage of that metric exceeds
+      # predefined thresholds during the current billing cycle. A `cost_exceeded` alert
+      # is triggered when the total amount due during the current billing cycle
+      # surpasses predefined thresholds. `cost_exceeded` alerts do not include burndown
+      # of pre-purchase credits. A `spend_exceeded` alert is triggered when the rated
+      # spend (the pricing subtotal, before invoice-level adjustments and credits)
+      # denominated in the alert's currency exceeds predefined thresholds during the
+      # current billing cycle; `price_filters` can scope which prices contribute. Each
       # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
-      # per metric that is a part of the subscription. Alerts are triggered based on
-      # usage or cost conditions met during the current billing cycle.
+      # per metric that is a part of the subscription.
       sig do
         params(
           subscription_id: String,
@@ -207,17 +210,18 @@ module Orb
         thresholds:,
         # The type of alert to create. This must be a valid alert type.
         type:,
-        # The case sensitive currency or custom pricing unit to use for grouped cost
-        # alerts. Required when grouping_keys is set.
+        # The case sensitive currency or custom pricing unit the alert is denominated in.
+        # Required for spend_exceeded alerts and when grouping_keys is set.
         currency: nil,
         # The property keys to group cost alerts by. Only applicable for cost_exceeded
         # alerts.
         grouping_keys: nil,
         # The metric to track usage for.
         metric_id: nil,
-        # Filters to scope which prices are included in grouped cost alert evaluation.
-        # Supports filtering by price_id, item_id, or price_type with includes/excludes
-        # operators. Only applicable when grouping_keys is set.
+        # Filters to scope which prices are included in alert evaluation. Supports
+        # filtering by price_id, item_id, or price_type with includes/excludes operators.
+        # Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
+        # grouping_keys set.
         price_filters: nil,
         # Per-group threshold overrides. Each override maps a specific combination of
         # grouping_keys values to a list of thresholds that fully replaces the default

data/sig/orb/models/alert.rbs

@@ -134,6 +134,7 @@ module Orb
         | :credit_balance_recovered
         | :usage_exceeded
         | :cost_exceeded
+        | :spend_exceeded
         | :license_balance_threshold_reached
 
       module Type
@@ -144,6 +145,7 @@ module Orb
         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
 
         def self?.values: -> ::Array[Orb::Models::Alert::type_]

data/sig/orb/models/alert_create_for_subscription_params.rbs

@@ -57,13 +57,14 @@ module Orb
         request_options: Orb::RequestOptions
       }
 
-      type type_ = :usage_exceeded | :cost_exceeded
+      type type_ = :usage_exceeded | :cost_exceeded | :spend_exceeded
 
       module Type
         extend Orb::Internal::Type::Enum
 
         USAGE_EXCEEDED: :usage_exceeded
         COST_EXCEEDED: :cost_exceeded
+        SPEND_EXCEEDED: :spend_exceeded
 
         def self?.values: -> ::Array[Orb::Models::AlertCreateForSubscriptionParams::type_]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Orb