orb-billing 1.46.0 → 1.48.0

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,10 @@ 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.
+        # A subscription's own fields, with its plan and customer as references, as listed
+        # by List subscription summaries and carried in standard webhook payloads. Fetch
+        # the subscription for its price intervals, billing periods, plan phases and other
+        # derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -265,9 +267,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. 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,10 @@ 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.
+        # A subscription's own fields, with its plan and customer as references, as listed
+        # by List subscription summaries and carried in standard webhook payloads. Fetch
+        # the subscription for its price intervals, billing periods, plan phases and other
+        # derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -245,9 +247,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. 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,10 @@ 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.
+        # A subscription's own fields, with its plan and customer as references, as listed
+        # by List subscription summaries and carried in standard webhook payloads. Fetch
+        # the subscription for its price intervals, billing periods, plan phases and other
+        # derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -269,9 +271,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. 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,10 @@ 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.
+        # A subscription's own fields, with its plan and customer as references, as listed
+        # by List subscription summaries and carried in standard webhook payloads. Fetch
+        # the subscription for its price intervals, billing periods, plan phases and other
+        # derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Subscription
@@ -94,9 +95,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -269,9 +271,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. 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,10 @@ 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.
+        # A subscription's own fields, with its plan and customer as references, as listed
+        # by List subscription summaries and carried in standard webhook payloads. Fetch
+        # the subscription for its price intervals, billing periods, plan phases and other
+        # derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Subscription
@@ -95,9 +96,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -1111,9 +1113,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. 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,10 @@ 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.
+        # A subscription's own fields, with its plan and customer as references, as listed
+        # by List subscription summaries and carried in standard webhook payloads. Fetch
+        # the subscription for its price intervals, billing periods, plan phases and other
+        # derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionStartedStandardWebhookEvent::Subscription
@@ -81,9 +82,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -210,9 +212,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. 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,10 @@ 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.
+        # A subscription's own fields, with its plan and customer as references, as listed
+        # by List subscription summaries and carried in standard webhook payloads. Fetch
+        # the subscription for its price intervals, billing periods, plan phases and other
+        # derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription
@@ -81,9 +82,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -210,9 +212,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. 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,10 @@ 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.
+        # A subscription's own fields, with its plan and customer as references, as listed
+        # by List subscription summaries and carried in standard webhook payloads. Fetch
+        # the subscription for its price intervals, billing periods, plan phases and other
+        # derived fields.
         sig do
           returns(
             Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription
@@ -95,9 +96,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           subscription:,
           # The event this payload describes.
           type:
@@ -1117,9 +1119,10 @@ 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.
+          # A subscription's own fields, with its plan and customer as references, as listed
+          # by List subscription summaries and carried in standard webhook payloads. Fetch
+          # the subscription for its price intervals, billing periods, plan phases and other
+          # derived fields.
           sig do
             params(
               id: String,

data/rbi/orb/models.rbi

@@ -106,6 +106,8 @@ module Orb
 
   CreditBlockRetrieveParams = Orb::Models::CreditBlockRetrieveParams
 
+  CreditBlockUpdateParams = Orb::Models::CreditBlockUpdateParams
+
   CreditNote = Orb::Models::CreditNote
 
   CreditNoteAccountingSyncFailedWebhookEvent =
@@ -392,6 +394,8 @@ module Orb
 
   MaximumInterval = Orb::Models::MaximumInterval
 
+  MetricArchiveParams = Orb::Models::MetricArchiveParams
+
   MetricCreateParams = Orb::Models::MetricCreateParams
 
   MetricEventsDroppedByWatermarkWebhookEvent =
@@ -401,6 +405,8 @@ module Orb
 
   MetricListParams = Orb::Models::MetricListParams
 
+  MetricUnarchiveParams = Orb::Models::MetricUnarchiveParams
+
   MetricUpdateParams = Orb::Models::MetricUpdateParams
 
   Minimum = Orb::Models::Minimum

data/rbi/orb/resources/credit_blocks.rbi

@@ -15,6 +15,32 @@ module Orb
       def retrieve(block_id, request_options: {})
       end
 
+      # This endpoint updates the `metadata` of a credit block. Keys you pass are added
+      # to the block's existing metadata or overwrite the value already stored for that
+      # key, and setting a key to `null` removes it. Passing `null` for `metadata`
+      # clears all of the block's metadata. The block's `increment` entry in the
+      # [credits ledger](fetch-customer-credits-ledger) reports the block's metadata, so
+      # it shows the update too.
+      #
+      # Other fields on a credit block cannot be changed through this endpoint. Deleted
+      # credit blocks return a 404.
+      sig do
+        params(
+          block_id: String,
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::CreditBlockUpdateResponse)
+      end
+      def update(
+        block_id,
+        # 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,
+        request_options: {}
+      )
+      end
+
       # This endpoint deletes a credit block by its ID.
       #
       # When a credit block is deleted:

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,10 +90,28 @@ 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
 
+      # This endpoint archives a [metric](/core-concepts#metric). Archived metrics are
+      # left out of `GET /v1/metrics` when filtering with `status=active`, and can't be
+      # chosen when creating new plans in the Orb dashboard.
+      #
+      # Archiving does not change existing prices, plans, or subscriptions that use the
+      # metric, and usage on those prices continues to be billed. A metric that is
+      # already archived cannot be archived again.
+      sig do
+        params(
+          metric_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::BillableMetric)
+      end
+      def archive(metric_id, request_options: {})
+      end
+
       # This endpoint is used to fetch [metric](/core-concepts#metric) details given a
       # metric identifier. It returns information about the metrics including its name,
       # description, and item.
@@ -95,6 +124,18 @@ module Orb
       def fetch(metric_id, request_options: {})
       end
 
+      # This endpoint restores an archived [metric](/core-concepts#metric) to `active`,
+      # so it can be chosen for new plans again. Only archived metrics can be
+      # unarchived.
+      sig do
+        params(
+          metric_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::BillableMetric)
+      end
+      def unarchive(metric_id, request_options: {})
+      end
+
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/orb/resources/plans/external_plan_id.rbi

@@ -8,8 +8,9 @@ module Orb
       # subscription. You can see more about how to configure prices in the
       # [Price resource](/reference/price).
       class ExternalPlanID
-        # This endpoint can be used to update the `external_plan_id`, `description`, and
-        # `metadata` of an existing plan.
+        # This endpoint can be used to update the `name`, `external_plan_id`,
+        # `description`, and `metadata` of an existing plan. A plan's `name` cannot be
+        # empty.
         #
         # Other fields on a plan are currently immutable.
         sig do
@@ -18,6 +19,7 @@ module Orb
             description: T.nilable(String),
             external_plan_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            name: T.nilable(String),
             request_options: Orb::RequestOptions::OrHash
           ).returns(Orb::Plan)
         end
@@ -33,6 +35,8 @@ module Orb
           # 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 plan.
+          name: nil,
           request_options: {}
         )
         end

data/rbi/orb/resources/plans.rbi

@@ -74,8 +74,9 @@ module Orb
       )
       end
 
-      # This endpoint can be used to update the `external_plan_id`, `description`, and
-      # `metadata` of an existing plan.
+      # This endpoint can be used to update the `name`, `external_plan_id`,
+      # `description`, and `metadata` of an existing plan. A plan's `name` cannot be
+      # empty.
       #
       # Other fields on a plan are currently immutable.
       sig do
@@ -84,6 +85,7 @@ module Orb
           description: T.nilable(String),
           external_plan_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          name: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::Plan)
       end
@@ -99,6 +101,8 @@ module Orb
         # 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 plan.
+        name: nil,
         request_options: {}
       )
       end