orb-billing 1.47.0 → 1.49.0

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

@@ -30,9 +30,10 @@ module Orb
         required :properties, Orb::Internal::Type::Unknown
 
         # @!attribute subscription
-        #   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.
+        #   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.
         #
         #   @return [Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription]
         required :subscription, -> { Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription }
@@ -58,7 +59,7 @@ module Orb
         #
         #   @param properties [Object]
         #
-        #   @param subscription [Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: its own fields, with its plan an
+        #   @param subscription [Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
         #
         #   @param type [Symbol, Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Type] The event this payload describes.
 
@@ -138,9 +139,10 @@ module Orb
           #   {Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription}
           #   for more details.
           #
-          #   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.
+          #   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.
           #
           #   @param id [String]
           #

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

@@ -30,9 +30,10 @@ module Orb
         required :properties, -> { Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Properties }
 
         # @!attribute subscription
-        #   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.
+        #   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.
         #
         #   @return [Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription]
         required :subscription, -> { Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription }
@@ -59,7 +60,7 @@ module Orb
         #
         #   @param properties [Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Properties]
         #
-        #   @param subscription [Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription] The subscription in a standard webhook payload: its own fields, with its plan an
+        #   @param subscription [Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
         #
         #   @param type [Symbol, Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Type] The event this payload describes.
 
@@ -616,9 +617,10 @@ module Orb
           #   {Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription}
           #   for more details.
           #
-          #   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.
+          #   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.
           #
           #   @param id [String]
           #

data/lib/orb/models.rb

@@ -140,6 +140,8 @@ module Orb
 
   CreditBlockRetrieveParams = Orb::Models::CreditBlockRetrieveParams
 
+  CreditBlockUpdateParams = Orb::Models::CreditBlockUpdateParams
+
   CreditNote = Orb::Models::CreditNote
 
   CreditNoteAccountingSyncFailedWebhookEvent = Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent
@@ -391,6 +393,8 @@ module Orb
 
   MaximumInterval = Orb::Models::MaximumInterval
 
+  MetricArchiveParams = Orb::Models::MetricArchiveParams
+
   MetricCreateParams = Orb::Models::MetricCreateParams
 
   MetricEventsDroppedByWatermarkWebhookEvent = Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent
@@ -399,6 +403,8 @@ module Orb
 
   MetricListParams = Orb::Models::MetricListParams
 
+  MetricUnarchiveParams = Orb::Models::MetricUnarchiveParams
+
   MetricUpdateParams = Orb::Models::MetricUpdateParams
 
   Minimum = Orb::Models::Minimum
@@ -745,6 +751,8 @@ module Orb
 
   SubscriptionListParams = Orb::Models::SubscriptionListParams
 
+  SubscriptionListSummaryParams = Orb::Models::SubscriptionListSummaryParams
+
   SubscriptionMinified = Orb::Models::SubscriptionMinified
 
   SubscriptionPlanChangedWebhookEvent = Orb::Models::SubscriptionPlanChangedWebhookEvent

data/lib/orb/resources/alerts.rb

@@ -233,8 +233,9 @@ module Orb
       # 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 plan can have one
-      # `cost_exceeded` alert and one `usage_exceeded` alert per metric that is a part
-      # of the plan.
+      # `cost_exceeded` alert, one `usage_exceeded` alert per metric that is a part of
+      # the plan, and up to 50 `spend_exceeded` alerts, one per combination of currency
+      # and `price_filters`, so separate products can each have their own spend alert.
       #
       # @overload create_for_plan(plan_id, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, plan_version: nil, price_filters: nil, request_options: {})
       #
@@ -285,8 +286,10 @@ module Orb
       # 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.
+      # subscription can have one `cost_exceeded` alert, one `usage_exceeded` alert per
+      # metric that is a part of the subscription, and up to 50 `spend_exceeded` alerts,
+      # one per combination of currency and `price_filters`, so separate products can
+      # each have their own spend alert.
       #
       # @overload create_for_subscription(subscription_id, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, price_filters: nil, threshold_overrides: nil, request_options: {})
       #

data/lib/orb/resources/credit_blocks.rb

@@ -24,6 +24,41 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CreditBlockUpdateParams} for more details.
+      #
+      # 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.
+      #
+      # @overload update(block_id, metadata: nil, request_options: {})
+      #
+      # @param block_id [String]
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::CreditBlockUpdateResponse]
+      #
+      # @see Orb::Models::CreditBlockUpdateParams
+      def update(block_id, params = {})
+        parsed, options = Orb::CreditBlockUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["credit_blocks/%1$s", block_id],
+          body: parsed,
+          model: Orb::Models::CreditBlockUpdateResponse,
+          options: options
+        )
+      end
+
       # This endpoint deletes a credit block by its ID.
       #
       # When a credit block is deleted:

data/lib/orb/resources/metrics.rb

@@ -123,6 +123,31 @@ module Orb
         )
       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.
+      #
+      # @overload archive(metric_id, request_options: {})
+      #
+      # @param metric_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::BillableMetric]
+      #
+      # @see Orb::Models::MetricArchiveParams
+      def archive(metric_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["metrics/%1$s/archive", metric_id],
+          model: Orb::BillableMetric,
+          options: params[: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.
@@ -144,6 +169,27 @@ module Orb
         )
       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.
+      #
+      # @overload unarchive(metric_id, request_options: {})
+      #
+      # @param metric_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::BillableMetric]
+      #
+      # @see Orb::Models::MetricUnarchiveParams
+      def unarchive(metric_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["metrics/%1$s/unarchive", metric_id],
+          model: Orb::BillableMetric,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Orb::Client]

data/lib/orb/resources/subscriptions.rb

@@ -897,6 +897,66 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::SubscriptionListSummaryParams} for more details.
+      #
+      # This is a lighter-weight version of
+      # [List subscriptions](/api-reference/subscription/list-subscriptions), with the
+      # same filters, pagination and order. It returns each subscription's own fields,
+      # with its plan and customer as references, and leaves out price intervals,
+      # billing periods, plan phases and other derived fields, making it faster to
+      # respond. Fetch a subscription for those.
+      #
+      # This is the same summary of a subscription that standard
+      # [webhook payloads](/integrations-and-exports/webhook-payload-styles) carry.
+      #
+      # @overload list_summary(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, external_plan_id: nil, limit: nil, plan_id: nil, status: nil, request_options: {})
+      #
+      # @param created_at_gt [Time, nil]
+      #
+      # @param created_at_gte [Time, nil]
+      #
+      # @param created_at_lt [Time, nil]
+      #
+      # @param created_at_lte [Time, nil]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #
+      # @param customer_id [String, nil]
+      #
+      # @param external_customer_id [String, nil]
+      #
+      # @param external_plan_id [String, nil]
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      # @param plan_id [String, nil]
+      #
+      # @param status [Symbol, Orb::Models::SubscriptionListSummaryParams::Status, nil]
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Internal::Page<Orb::Models::SubscriptionListSummaryResponse>]
+      #
+      # @see Orb::Models::SubscriptionListSummaryParams
+      def list_summary(params = {})
+        parsed, options = Orb::SubscriptionListSummaryParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "subscriptions/summary",
+          query: query.transform_keys(
+            created_at_gt: "created_at[gt]",
+            created_at_gte: "created_at[gte]",
+            created_at_lt: "created_at[lt]",
+            created_at_lte: "created_at[lte]"
+          ),
+          page: Orb::Internal::Page,
+          model: Orb::Models::SubscriptionListSummaryResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Orb::Models::SubscriptionPriceIntervalsParams} for more details.
       #

data/lib/orb/version.rb

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

data/lib/orb.rb

@@ -107,6 +107,8 @@ require_relative "orb/models/credit_block_list_invoices_params"
 require_relative "orb/models/credit_block_list_invoices_response"
 require_relative "orb/models/credit_block_retrieve_params"
 require_relative "orb/models/credit_block_retrieve_response"
+require_relative "orb/models/credit_block_update_params"
+require_relative "orb/models/credit_block_update_response"
 require_relative "orb/models/credit_note"
 require_relative "orb/models/credit_note_accounting_sync_failed_webhook_event"
 require_relative "orb/models/credit_note_accounting_sync_succeeded_webhook_event"
@@ -304,10 +306,12 @@ require_relative "orb/models/matrix_value"
 require_relative "orb/models/matrix_with_allocation_config"
 require_relative "orb/models/maximum"
 require_relative "orb/models/maximum_interval"
+require_relative "orb/models/metric_archive_params"
 require_relative "orb/models/metric_create_params"
 require_relative "orb/models/metric_events_dropped_by_watermark_webhook_event"
 require_relative "orb/models/metric_fetch_params"
 require_relative "orb/models/metric_list_params"
+require_relative "orb/models/metric_unarchive_params"
 require_relative "orb/models/metric_update_params"
 require_relative "orb/models/minimum"
 require_relative "orb/models/minimum_interval"
@@ -491,6 +495,8 @@ require_relative "orb/models/subscription_invoicing_threshold_exceeded_webhook_e
 require_relative "orb/models/subscription_license_allocation_reset_webhook_event"
 require_relative "orb/models/subscription_license_balance_threshold_reached_webhook_event"
 require_relative "orb/models/subscription_list_params"
+require_relative "orb/models/subscription_list_summary_params"
+require_relative "orb/models/subscription_list_summary_response"
 require_relative "orb/models/subscription_minified"
 require_relative "orb/models/subscription_plan_changed_webhook_event"
 require_relative "orb/models/subscription_plan_change_scheduled_webhook_event"

data/rbi/orb/models/credit_block_update_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Orb
+  module Models
+    class CreditBlockUpdateParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::CreditBlockUpdateParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :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`.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_accessor :metadata
+
+      sig do
+        params(
+          block_id: String,
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+
+      sig do
+        override.returns(
+          {
+            block_id: String,
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end