orb-billing 1.47.0 → 1.49.0

data/rbi/orb/resources/metrics.rbi

@@ -96,6 +96,22 @@ 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.
+      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.
@@ -108,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/subscriptions.rbi

@@ -923,6 +923,53 @@ module Orb
       )
       end
 
+      # 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.
+      sig do
+        params(
+          created_at_gt: T.nilable(Time),
+          created_at_gte: T.nilable(Time),
+          created_at_lt: T.nilable(Time),
+          created_at_lte: T.nilable(Time),
+          cursor: T.nilable(String),
+          customer_id: T.nilable(String),
+          external_customer_id: T.nilable(String),
+          external_plan_id: T.nilable(String),
+          limit: Integer,
+          plan_id: T.nilable(String),
+          status:
+            T.nilable(Orb::SubscriptionListSummaryParams::Status::OrSymbol),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(
+          Orb::Internal::Page[Orb::Models::SubscriptionListSummaryResponse]
+        )
+      end
+      def list_summary(
+        created_at_gt: nil,
+        created_at_gte: nil,
+        created_at_lt: nil,
+        created_at_lte: nil,
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
+        cursor: nil,
+        customer_id: nil,
+        external_customer_id: nil,
+        external_plan_id: nil,
+        # The number of items to fetch. Defaults to 20.
+        limit: nil,
+        plan_id: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
       # This endpoint is used to add and edit subscription
       # [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By
       # making modifications to a subscription’s price intervals, you can

data/sig/orb/models/credit_block_update_params.rbs

@@ -0,0 +1,28 @@
+module Orb
+  module Models
+    type credit_block_update_params =
+      { block_id: String, metadata: ::Hash[Symbol, String?]? }
+      & Orb::Internal::Type::request_parameters
+
+    class CreditBlockUpdateParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor block_id: String
+
+      attr_accessor metadata: ::Hash[Symbol, String?]?
+
+      def initialize: (
+        block_id: String,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        block_id: String,
+        metadata: ::Hash[Symbol, String?]?,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models/credit_block_update_response.rbs

@@ -0,0 +1,263 @@
+module Orb
+  module Models
+    type credit_block_update_response =
+      {
+        id: String,
+        balance: Float,
+        credit_block_source: Orb::Models::CreditBlockUpdateResponse::credit_block_source,
+        effective_date: Time?,
+        expiry_date: Time?,
+        filters: ::Array[Orb::Models::CreditBlockUpdateResponse::Filter],
+        maximum_initial_balance: Float?,
+        metadata: ::Hash[Symbol, String],
+        per_unit_cost_basis: String?,
+        status: Orb::Models::CreditBlockUpdateResponse::status,
+        credit_allocation: Orb::Models::CreditBlockUpdateResponse::CreditAllocation?,
+        credit_commitment: Orb::Models::CreditBlockUpdateResponse::CreditCommitment?
+      }
+
+    class CreditBlockUpdateResponse < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor balance: Float
+
+      attr_accessor credit_block_source: Orb::Models::CreditBlockUpdateResponse::credit_block_source
+
+      attr_accessor effective_date: Time?
+
+      attr_accessor expiry_date: Time?
+
+      attr_accessor filters: ::Array[Orb::Models::CreditBlockUpdateResponse::Filter]
+
+      attr_accessor maximum_initial_balance: Float?
+
+      attr_accessor metadata: ::Hash[Symbol, String]
+
+      attr_accessor per_unit_cost_basis: String?
+
+      attr_accessor status: Orb::Models::CreditBlockUpdateResponse::status
+
+      attr_accessor credit_allocation: Orb::Models::CreditBlockUpdateResponse::CreditAllocation?
+
+      attr_accessor credit_commitment: Orb::Models::CreditBlockUpdateResponse::CreditCommitment?
+
+      def initialize: (
+        id: String,
+        balance: Float,
+        credit_block_source: Orb::Models::CreditBlockUpdateResponse::credit_block_source,
+        effective_date: Time?,
+        expiry_date: Time?,
+        filters: ::Array[Orb::Models::CreditBlockUpdateResponse::Filter],
+        maximum_initial_balance: Float?,
+        metadata: ::Hash[Symbol, String],
+        per_unit_cost_basis: String?,
+        status: Orb::Models::CreditBlockUpdateResponse::status,
+        ?credit_allocation: Orb::Models::CreditBlockUpdateResponse::CreditAllocation?,
+        ?credit_commitment: Orb::Models::CreditBlockUpdateResponse::CreditCommitment?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        balance: Float,
+        credit_block_source: Orb::Models::CreditBlockUpdateResponse::credit_block_source,
+        effective_date: Time?,
+        expiry_date: Time?,
+        filters: ::Array[Orb::Models::CreditBlockUpdateResponse::Filter],
+        maximum_initial_balance: Float?,
+        metadata: ::Hash[Symbol, String],
+        per_unit_cost_basis: String?,
+        status: Orb::Models::CreditBlockUpdateResponse::status,
+        credit_allocation: Orb::Models::CreditBlockUpdateResponse::CreditAllocation?,
+        credit_commitment: Orb::Models::CreditBlockUpdateResponse::CreditCommitment?
+      }
+
+      type credit_block_source = :allocation | :top_up | :commitment | :manual
+
+      module CreditBlockSource
+        extend Orb::Internal::Type::Enum
+
+        ALLOCATION: :allocation
+        TOP_UP: :top_up
+        COMMITMENT: :commitment
+        MANUAL: :manual
+
+        def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::credit_block_source]
+      end
+
+      type filter =
+        {
+          field: Orb::Models::CreditBlockUpdateResponse::Filter::field,
+          operator: Orb::Models::CreditBlockUpdateResponse::Filter::operator,
+          values: ::Array[String]
+        }
+
+      class Filter < Orb::Internal::Type::BaseModel
+        attr_accessor field: Orb::Models::CreditBlockUpdateResponse::Filter::field
+
+        attr_accessor operator: Orb::Models::CreditBlockUpdateResponse::Filter::operator
+
+        attr_accessor values: ::Array[String]
+
+        def initialize: (
+          field: Orb::Models::CreditBlockUpdateResponse::Filter::field,
+          operator: Orb::Models::CreditBlockUpdateResponse::Filter::operator,
+          values: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          field: Orb::Models::CreditBlockUpdateResponse::Filter::field,
+          operator: Orb::Models::CreditBlockUpdateResponse::Filter::operator,
+          values: ::Array[String]
+        }
+
+        type field =
+          :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID: :price_id
+          ITEM_ID: :item_id
+          PRICE_TYPE: :price_type
+          CURRENCY: :currency
+          PRICING_UNIT_ID: :pricing_unit_id
+
+          def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::Filter::field]
+        end
+
+        type operator = :includes | :excludes
+
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES: :includes
+          EXCLUDES: :excludes
+
+          def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::Filter::operator]
+        end
+      end
+
+      type status = :active | :pending_payment
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE: :active
+        PENDING_PAYMENT: :pending_payment
+
+        def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::status]
+      end
+
+      type credit_allocation =
+        {
+          allows_rollover: bool,
+          currency: String,
+          custom_expiration: Orb::CustomExpiration?,
+          item_id: String,
+          filters: ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter],
+          license_type_id: String?
+        }
+
+      class CreditAllocation < Orb::Internal::Type::BaseModel
+        attr_accessor allows_rollover: bool
+
+        attr_accessor currency: String
+
+        attr_accessor custom_expiration: Orb::CustomExpiration?
+
+        attr_accessor item_id: String
+
+        attr_reader filters: ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter]?
+
+        def filters=: (
+          ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter]
+        ) -> ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter]
+
+        attr_accessor license_type_id: String?
+
+        def initialize: (
+          allows_rollover: bool,
+          currency: String,
+          custom_expiration: Orb::CustomExpiration?,
+          item_id: String,
+          ?filters: ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter],
+          ?license_type_id: String?
+        ) -> void
+
+        def to_hash: -> {
+          allows_rollover: bool,
+          currency: String,
+          custom_expiration: Orb::CustomExpiration?,
+          item_id: String,
+          filters: ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter],
+          license_type_id: String?
+        }
+
+        type filter =
+          {
+            field: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field,
+            operator: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator,
+            values: ::Array[String]
+          }
+
+        class Filter < Orb::Internal::Type::BaseModel
+          attr_accessor field: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field
+
+          attr_accessor operator: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator
+
+          attr_accessor values: ::Array[String]
+
+          def initialize: (
+            field: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field,
+            operator: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator,
+            values: ::Array[String]
+          ) -> void
+
+          def to_hash: -> {
+            field: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field,
+            operator: Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator,
+            values: ::Array[String]
+          }
+
+          type field =
+            :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+          module Field
+            extend Orb::Internal::Type::Enum
+
+            PRICE_ID: :price_id
+            ITEM_ID: :item_id
+            PRICE_TYPE: :price_type
+            CURRENCY: :currency
+            PRICING_UNIT_ID: :pricing_unit_id
+
+            def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::field]
+          end
+
+          type operator = :includes | :excludes
+
+          module Operator
+            extend Orb::Internal::Type::Enum
+
+            INCLUDES: :includes
+            EXCLUDES: :excludes
+
+            def self?.values: -> ::Array[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::operator]
+          end
+        end
+      end
+
+      type credit_commitment = { id: String, subscription_id: String? }
+
+      class CreditCommitment < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor subscription_id: String?
+
+        def initialize: (id: String, ?subscription_id: String?) -> void
+
+        def to_hash: -> { id: String, subscription_id: String? }
+      end
+    end
+  end
+end

data/sig/orb/models/metric_archive_params.rbs

@@ -0,0 +1,23 @@
+module Orb
+  module Models
+    type metric_archive_params =
+      { metric_id: String } & Orb::Internal::Type::request_parameters
+
+    class MetricArchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor metric_id: String
+
+      def initialize: (
+        metric_id: String,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        metric_id: String,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models/metric_unarchive_params.rbs

@@ -0,0 +1,23 @@
+module Orb
+  module Models
+    type metric_unarchive_params =
+      { metric_id: String } & Orb::Internal::Type::request_parameters
+
+    class MetricUnarchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor metric_id: String
+
+      def initialize: (
+        metric_id: String,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        metric_id: String,
+        request_options: Orb::RequestOptions
+      }
+    end
+  end
+end

data/sig/orb/models/subscription_list_summary_params.rbs

@@ -0,0 +1,90 @@
+module Orb
+  module Models
+    type subscription_list_summary_params =
+      {
+        created_at_gt: Time?,
+        created_at_gte: Time?,
+        created_at_lt: Time?,
+        created_at_lte: Time?,
+        cursor: String?,
+        customer_id: String?,
+        external_customer_id: String?,
+        external_plan_id: String?,
+        limit: Integer,
+        plan_id: String?,
+        status: Orb::Models::SubscriptionListSummaryParams::status?
+      }
+      & Orb::Internal::Type::request_parameters
+
+    class SubscriptionListSummaryParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      attr_accessor created_at_gt: Time?
+
+      attr_accessor created_at_gte: Time?
+
+      attr_accessor created_at_lt: Time?
+
+      attr_accessor created_at_lte: Time?
+
+      attr_accessor cursor: String?
+
+      attr_accessor customer_id: String?
+
+      attr_accessor external_customer_id: String?
+
+      attr_accessor external_plan_id: String?
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_accessor plan_id: String?
+
+      attr_accessor status: Orb::Models::SubscriptionListSummaryParams::status?
+
+      def initialize: (
+        ?created_at_gt: Time?,
+        ?created_at_gte: Time?,
+        ?created_at_lt: Time?,
+        ?created_at_lte: Time?,
+        ?cursor: String?,
+        ?customer_id: String?,
+        ?external_customer_id: String?,
+        ?external_plan_id: String?,
+        ?limit: Integer,
+        ?plan_id: String?,
+        ?status: Orb::Models::SubscriptionListSummaryParams::status?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        created_at_gt: Time?,
+        created_at_gte: Time?,
+        created_at_lt: Time?,
+        created_at_lte: Time?,
+        cursor: String?,
+        customer_id: String?,
+        external_customer_id: String?,
+        external_plan_id: String?,
+        limit: Integer,
+        plan_id: String?,
+        status: Orb::Models::SubscriptionListSummaryParams::status?,
+        request_options: Orb::RequestOptions
+      }
+
+      type status = :active | :ended | :upcoming
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE: :active
+        ENDED: :ended
+        UPCOMING: :upcoming
+
+        def self?.values: -> ::Array[Orb::Models::SubscriptionListSummaryParams::status]
+      end
+    end
+  end
+end

data/sig/orb/models/subscription_list_summary_response.rbs

@@ -0,0 +1,94 @@
+module Orb
+  module Models
+    type subscription_list_summary_response =
+      {
+        id: String,
+        created_at: Time,
+        customer: Orb::CustomerMinified,
+        end_date: Time?,
+        metadata: ::Hash[Symbol, String],
+        name: String,
+        plan: Orb::Models::SubscriptionListSummaryResponse::Plan?,
+        start_date: Time,
+        status: Orb::Models::SubscriptionListSummaryResponse::status
+      }
+
+    class SubscriptionListSummaryResponse < Orb::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor customer: Orb::CustomerMinified
+
+      attr_accessor end_date: Time?
+
+      attr_accessor metadata: ::Hash[Symbol, String]
+
+      attr_accessor name: String
+
+      attr_accessor plan: Orb::Models::SubscriptionListSummaryResponse::Plan?
+
+      attr_accessor start_date: Time
+
+      attr_accessor status: Orb::Models::SubscriptionListSummaryResponse::status
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        customer: Orb::CustomerMinified,
+        end_date: Time?,
+        metadata: ::Hash[Symbol, String],
+        name: String,
+        plan: Orb::Models::SubscriptionListSummaryResponse::Plan?,
+        start_date: Time,
+        status: Orb::Models::SubscriptionListSummaryResponse::status
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        customer: Orb::CustomerMinified,
+        end_date: Time?,
+        metadata: ::Hash[Symbol, String],
+        name: String,
+        plan: Orb::Models::SubscriptionListSummaryResponse::Plan?,
+        start_date: Time,
+        status: Orb::Models::SubscriptionListSummaryResponse::status
+      }
+
+      type plan = { id: String?, external_plan_id: String?, name: String? }
+
+      class Plan < Orb::Internal::Type::BaseModel
+        attr_accessor id: String?
+
+        attr_accessor external_plan_id: String?
+
+        attr_accessor name: String?
+
+        def initialize: (
+          id: String?,
+          external_plan_id: String?,
+          name: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String?,
+          external_plan_id: String?,
+          name: String?
+        }
+      end
+
+      type status = :active | :ended | :upcoming
+
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE: :active
+        ENDED: :ended
+        UPCOMING: :upcoming
+
+        def self?.values: -> ::Array[Orb::Models::SubscriptionListSummaryResponse::status]
+      end
+    end
+  end
+end

data/sig/orb/models.rbs

@@ -99,6 +99,8 @@ module Orb
 
   class CreditBlockRetrieveParams = Orb::Models::CreditBlockRetrieveParams
 
+  class CreditBlockUpdateParams = Orb::Models::CreditBlockUpdateParams
+
   class CreditNote = Orb::Models::CreditNote
 
   class CreditNoteAccountingSyncFailedWebhookEvent = Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent
@@ -341,6 +343,8 @@ module Orb
 
   class MaximumInterval = Orb::Models::MaximumInterval
 
+  class MetricArchiveParams = Orb::Models::MetricArchiveParams
+
   class MetricCreateParams = Orb::Models::MetricCreateParams
 
   class MetricEventsDroppedByWatermarkWebhookEvent = Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent
@@ -349,6 +353,8 @@ module Orb
 
   class MetricListParams = Orb::Models::MetricListParams
 
+  class MetricUnarchiveParams = Orb::Models::MetricUnarchiveParams
+
   class MetricUpdateParams = Orb::Models::MetricUpdateParams
 
   class Minimum = Orb::Models::Minimum
@@ -681,6 +687,8 @@ module Orb
 
   class SubscriptionListParams = Orb::Models::SubscriptionListParams
 
+  class SubscriptionListSummaryParams = Orb::Models::SubscriptionListSummaryParams
+
   class SubscriptionMinified = Orb::Models::SubscriptionMinified
 
   class SubscriptionPlanChangedWebhookEvent = Orb::Models::SubscriptionPlanChangedWebhookEvent

data/sig/orb/resources/credit_blocks.rbs

@@ -6,6 +6,12 @@ module Orb
         ?request_options: Orb::request_opts
       ) -> Orb::Models::CreditBlockRetrieveResponse
 
+      def update: (
+        String block_id,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::CreditBlockUpdateResponse
+
       def delete: (String block_id, ?request_options: Orb::request_opts) -> nil
 
       def list_invoices: (

data/sig/orb/resources/metrics.rbs

@@ -29,11 +29,21 @@ module Orb
         ?request_options: Orb::request_opts
       ) -> Orb::Internal::Page[Orb::BillableMetric]
 
+      def archive: (
+        String metric_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::BillableMetric
+
       def fetch: (
         String metric_id,
         ?request_options: Orb::request_opts
       ) -> Orb::BillableMetric
 
+      def unarchive: (
+        String metric_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::BillableMetric
+
       def initialize: (client: Orb::Client) -> void
     end
   end