orb-billing 1.46.0 → 1.47.0

data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi

@@ -32,9 +32,9 @@ module Orb
         sig { returns(T.anything) }
         attr_accessor :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionEndedStandardWebhookEvent::Subscription
@@ -81,9 +81,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -210,9 +210,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi

@@ -44,9 +44,9 @@ module Orb
         end
         attr_writer :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -270,9 +270,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi

@@ -46,10 +46,8 @@ module Orb
         end
         attr_writer :properties
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           returns(
             Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Subscription
@@ -99,10 +97,8 @@ module Orb
           # Every group that crossed a threshold for one alert, batched into a single
           # message.
           properties:,
-          # A lightweight subscription representation for webhook payloads.
-          #
-          # This avoids the expensive to_subscription_params() call required for full
-          # serialization.
+          # The subscription in a license or grouped cost webhook payload: its status,
+          # dates, plan and customer.
           subscription:,
           # The event this payload describes.
           type:
@@ -1155,10 +1151,8 @@ module Orb
           end
           attr_accessor :status
 
-          # A lightweight subscription representation for webhook payloads.
-          #
-          # This avoids the expensive to_subscription_params() call required for full
-          # serialization.
+          # The subscription in a license or grouped cost webhook payload: its status,
+          # dates, plan and customer.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi

@@ -44,10 +44,8 @@ module Orb
         end
         attr_writer :properties
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           returns(
             Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription
@@ -96,10 +94,8 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # A lightweight subscription representation for webhook payloads.
-          #
-          # This avoids the expensive to_subscription_params() call required for full
-          # serialization.
+          # The subscription in a license or grouped cost webhook payload: its status,
+          # dates, plan and customer.
           subscription:,
           # The event this payload describes.
           type:
@@ -262,10 +258,8 @@ module Orb
           end
           attr_accessor :status
 
-          # A lightweight subscription representation for webhook payloads.
-          #
-          # This avoids the expensive to_subscription_params() call required for full
-          # serialization.
+          # The subscription in a license or grouped cost webhook payload: its status,
+          # dates, plan and customer.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi

@@ -46,10 +46,8 @@ module Orb
         end
         attr_writer :properties
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           returns(
             Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription
@@ -99,10 +97,8 @@ module Orb
           # Fires at the start of a billing period when license allocations are replenished.
           # Allocations sharing a billing period are batched into one message.
           properties:,
-          # A lightweight subscription representation for webhook payloads.
-          #
-          # This avoids the expensive to_subscription_params() call required for full
-          # serialization.
+          # The subscription in a license or grouped cost webhook payload: its status,
+          # dates, plan and customer.
           subscription:,
           # The event this payload describes.
           type:
@@ -311,10 +307,8 @@ module Orb
           end
           attr_accessor :status
 
-          # A lightweight subscription representation for webhook payloads.
-          #
-          # This avoids the expensive to_subscription_params() call required for full
-          # serialization.
+          # The subscription in a license or grouped cost webhook payload: its status,
+          # dates, plan and customer.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi

@@ -46,10 +46,8 @@ module Orb
         end
         attr_writer :properties
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           returns(
             Orb::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent::Subscription
@@ -99,10 +97,8 @@ module Orb
           # Every license that crossed a threshold for one alert, batched into a single
           # message. For account-wide alerts the licenses may span several license types.
           properties:,
-          # A lightweight subscription representation for webhook payloads.
-          #
-          # This avoids the expensive to_subscription_params() call required for full
-          # serialization.
+          # The subscription in a license or grouped cost webhook payload: its status,
+          # dates, plan and customer.
           subscription:,
           # The event this payload describes.
           type:
@@ -1153,10 +1149,8 @@ module Orb
           end
           attr_accessor :status
 
-          # A lightweight subscription representation for webhook payloads.
-          #
-          # This avoids the expensive to_subscription_params() call required for full
-          # serialization.
+          # The subscription in a license or grouped cost webhook payload: its status,
+          # dates, plan and customer.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi

@@ -44,9 +44,9 @@ module Orb
         end
         attr_writer :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -265,9 +265,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi

@@ -44,9 +44,9 @@ module Orb
         end
         attr_writer :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -245,9 +245,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi

@@ -44,9 +44,9 @@ module Orb
         end
         attr_writer :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -269,9 +269,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi

@@ -44,9 +44,9 @@ module Orb
         end
         attr_writer :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -269,9 +269,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi

@@ -44,9 +44,9 @@ module Orb
         end
         attr_writer :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Subscription
@@ -95,9 +95,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -1111,9 +1111,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi

@@ -32,9 +32,9 @@ module Orb
         sig { returns(T.anything) }
         attr_accessor :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionStartedStandardWebhookEvent::Subscription
@@ -81,9 +81,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -210,9 +210,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi

@@ -32,9 +32,9 @@ module Orb
         sig { returns(T.anything) }
         attr_accessor :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription
@@ -81,9 +81,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -210,9 +210,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi

@@ -44,9 +44,9 @@ module Orb
         end
         attr_writer :properties
 
-        # The subscription in a standard webhook payload: the fields readable without
-        # to_subscription_params(), which every interval, billing period and plan phase
-        # depends on.
+        # The subscription in a standard webhook payload: its own fields, with its plan
+        # and customer as references. Fetch the subscription for its price intervals,
+        # billing periods, plan phases and other derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription
@@ -95,9 +95,9 @@ module Orb
           # endpoint.
           payload_style:,
           properties:,
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -1117,9 +1117,9 @@ module Orb
           end
           attr_accessor :status
 
-          # The subscription in a standard webhook payload: the fields readable without
-          # to_subscription_params(), which every interval, billing period and plan phase
-          # depends on.
+          # The subscription in a standard webhook payload: its own fields, with its plan
+          # and customer as references. Fetch the subscription for its price intervals,
+          # billing periods, plan phases and other derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/resources/metrics.rbi

@@ -36,28 +36,38 @@ module Orb
       )
       end
 
-      # This endpoint allows you to update the `metadata` property on a metric. If you
-      # pass `null` for the metadata value, it will clear any existing metadata for that
-      # invoice.
+      # This endpoint allows you to update the `name`, `description`, and `metadata`
+      # properties on a metric. Fields left out of the request are not changed, and
+      # `name` cannot be empty. If you pass `null` for the metadata value, it will clear
+      # any existing metadata for that metric.
       sig do
         params(
           metric_id: String,
+          description: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          name: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::BillableMetric)
       end
       def update(
         metric_id,
+        # A description of the metric.
+        description: nil,
         # User-specified key/value pairs for the resource. Individual keys can be removed
         # by setting the value to `null`, and the entire metadata mapping can be cleared
         # by setting `metadata` to `null`.
         metadata: nil,
+        # The name of the metric.
+        name: nil,
         request_options: {}
       )
       end
 
       # This endpoint is used to list [metrics](/core-concepts#metric). It returns
       # information about the metrics including its name, description, and item.
+      #
+      # Pass `status` to only return metrics with that status, e.g. `status=active` to
+      # leave out archived metrics.
       sig do
         params(
           created_at_gt: T.nilable(Time),
@@ -66,6 +76,7 @@ module Orb
           created_at_lte: T.nilable(Time),
           cursor: T.nilable(String),
           limit: Integer,
+          status: T.nilable(Orb::MetricListParams::Status::OrSymbol),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::Internal::Page[Orb::BillableMetric])
       end
@@ -79,6 +90,8 @@ module Orb
         cursor: nil,
         # The number of items to fetch. Defaults to 20.
         limit: nil,
+        # The metric status to filter to ('active', 'archived', or 'draft').
+        status: nil,
         request_options: {}
       )
       end