orb-billing 1.13.0 → 1.14.0

data/rbi/orb/models/price_evaluate_params.rbi

@@ -9,6 +9,9 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::PriceEvaluateParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :price_id
+
       # The exclusive upper bound for event timestamps
       sig { returns(Time) }
       attr_accessor :timeframe_end
@@ -47,6 +50,7 @@ module Orb
 
       sig do
         params(
+          price_id: String,
           timeframe_end: Time,
           timeframe_start: Time,
           customer_id: T.nilable(String),
@@ -58,6 +62,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        price_id:,
         # The exclusive upper bound for event timestamps
         timeframe_end:,
         # The inclusive lower bound for event timestamps
@@ -84,6 +89,7 @@ module Orb
       sig do
         override.returns(
           {
+            price_id: String,
             timeframe_end: Time,
             timeframe_start: Time,
             customer_id: T.nilable(String),

data/rbi/orb/models/price_fetch_params.rbi

@@ -9,15 +9,23 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::PriceFetchParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :price_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          price_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(price_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { price_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/price_update_params.rbi

@@ -9,6 +9,9 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::PriceUpdateParams, Orb::Internal::AnyHash) }
 
+      sig { returns(String) }
+      attr_accessor :price_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`.
@@ -17,11 +20,13 @@ module Orb
 
       sig do
         params(
+          price_id: String,
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        price_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`.
@@ -33,6 +38,7 @@ module Orb
       sig do
         override.returns(
           {
+            price_id: String,
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
             request_options: Orb::RequestOptions
           }

data/rbi/orb/models/prices/external_price_id_fetch_params.rbi

@@ -15,15 +15,23 @@ module Orb
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :external_price_id
+
         sig do
-          params(request_options: Orb::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            external_price_id: String,
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(external_price_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: Orb::RequestOptions }) }
+        sig do
+          override.returns(
+            { external_price_id: String, request_options: Orb::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/orb/models/prices/external_price_id_update_params.rbi

@@ -15,6 +15,9 @@ module Orb
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :external_price_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`.
@@ -23,11 +26,13 @@ module Orb
 
         sig do
           params(
+            external_price_id: String,
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
             request_options: Orb::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          external_price_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`.
@@ -39,6 +44,7 @@ module Orb
         sig do
           override.returns(
             {
+              external_price_id: String,
               metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
               request_options: Orb::RequestOptions
             }

data/rbi/orb/models/subscription_cancel_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::SubscriptionCancelParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # Determines the timing of subscription cancellation
       sig { returns(Orb::SubscriptionCancelParams::CancelOption::OrSymbol) }
       attr_accessor :cancel_option
@@ -28,6 +31,7 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           cancel_option: Orb::SubscriptionCancelParams::CancelOption::OrSymbol,
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
           cancellation_date: T.nilable(Time),
@@ -35,6 +39,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # Determines the timing of subscription cancellation
         cancel_option:,
         # If false, this request will fail if it would void an issued invoice or create a
@@ -51,6 +56,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             cancel_option:
               Orb::SubscriptionCancelParams::CancelOption::OrSymbol,
             allow_invoice_credit_or_void: T.nilable(T::Boolean),

data/rbi/orb/models/subscription_change_apply_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::SubscriptionChangeApplyParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_change_id
+
       # Description to apply to the balance transaction representing this credit.
       sig { returns(T.nilable(String)) }
       attr_accessor :description
@@ -41,6 +44,7 @@ module Orb
 
       sig do
         params(
+          subscription_change_id: String,
           description: T.nilable(String),
           mark_as_paid: T.nilable(T::Boolean),
           payment_external_id: T.nilable(String),
@@ -51,6 +55,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_change_id:,
         # Description to apply to the balance transaction representing this credit.
         description: nil,
         # Mark all pending invoices that are payable as paid. If amount is also provided,
@@ -74,6 +79,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_change_id: String,
             description: T.nilable(String),
             mark_as_paid: T.nilable(T::Boolean),
             payment_external_id: T.nilable(String),

data/rbi/orb/models/subscription_change_cancel_params.rbi

@@ -11,15 +11,26 @@ module Orb
           T.any(Orb::SubscriptionChangeCancelParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_change_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          subscription_change_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(subscription_change_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            subscription_change_id: String,
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/subscription_change_retrieve_params.rbi

@@ -11,15 +11,26 @@ module Orb
           T.any(Orb::SubscriptionChangeRetrieveParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_change_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          subscription_change_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(subscription_change_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            subscription_change_id: String,
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/subscription_fetch_costs_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::SubscriptionFetchCostsParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # The currency or custom pricing unit to use.
       sig { returns(T.nilable(String)) }
       attr_accessor :currency
@@ -36,6 +39,7 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           currency: T.nilable(String),
           timeframe_end: T.nilable(Time),
           timeframe_start: T.nilable(Time),
@@ -45,6 +49,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # The currency or custom pricing unit to use.
         currency: nil,
         # Costs returned are exclusive of `timeframe_end`.
@@ -63,6 +68,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             currency: T.nilable(String),
             timeframe_end: T.nilable(Time),
             timeframe_start: T.nilable(Time),

data/rbi/orb/models/subscription_fetch_params.rbi

@@ -11,15 +11,23 @@ module Orb
           T.any(Orb::SubscriptionFetchParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          subscription_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(subscription_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { subscription_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/subscription_fetch_schedule_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::SubscriptionFetchScheduleParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # Cursor for pagination. This can be populated by the `next_cursor` value returned
       # from the initial request.
       sig { returns(T.nilable(String)) }
@@ -37,6 +40,7 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           cursor: T.nilable(String),
           limit: Integer,
           start_date_gt: T.nilable(Time),
@@ -47,6 +51,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
         # from the initial request.
         cursor: nil,
@@ -63,6 +68,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             cursor: T.nilable(String),
             limit: Integer,
             start_date_gt: T.nilable(Time),

data/rbi/orb/models/subscription_fetch_usage_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::SubscriptionFetchUsageParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # When specified in conjunction with `group_by`, this parameter filters usage to a
       # single billable metric. Note that both `group_by` and `billable_metric_id` must
       # be specified together.
@@ -62,6 +65,7 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           billable_metric_id: T.nilable(String),
           first_dimension_key: T.nilable(String),
           first_dimension_value: T.nilable(String),
@@ -78,6 +82,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # When specified in conjunction with `group_by`, this parameter filters usage to a
         # single billable metric. Note that both `group_by` and `billable_metric_id` must
         # be specified together.
@@ -106,6 +111,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             billable_metric_id: T.nilable(String),
             first_dimension_key: T.nilable(String),
             first_dimension_value: T.nilable(String),

data/rbi/orb/models/subscription_price_intervals_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::SubscriptionPriceIntervalsParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # A list of price intervals to add to the subscription.
       sig do
         returns(T.nilable(T::Array[Orb::SubscriptionPriceIntervalsParams::Add]))
@@ -92,6 +95,7 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           add: T::Array[Orb::SubscriptionPriceIntervalsParams::Add::OrHash],
           add_adjustments:
             T::Array[
@@ -108,6 +112,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # A list of price intervals to add to the subscription.
         add: nil,
         # A list of adjustments to add to the subscription.
@@ -130,6 +135,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             add: T::Array[Orb::SubscriptionPriceIntervalsParams::Add],
             add_adjustments:
               T::Array[Orb::SubscriptionPriceIntervalsParams::AddAdjustment],

data/rbi/orb/models/subscription_redeem_coupon_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::SubscriptionRedeemCouponParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       sig do
         returns(Orb::SubscriptionRedeemCouponParams::ChangeOption::OrSymbol)
       end
@@ -37,6 +40,7 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           change_option:
             Orb::SubscriptionRedeemCouponParams::ChangeOption::OrSymbol,
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
@@ -47,6 +51,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         change_option:,
         # If false, this request will fail if it would void an issued invoice or create a
         # credit note. Consider using this as a safety mechanism if you do not expect
@@ -66,6 +71,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             change_option:
               Orb::SubscriptionRedeemCouponParams::ChangeOption::OrSymbol,
             allow_invoice_credit_or_void: T.nilable(T::Boolean),

data/rbi/orb/models/subscription_schedule_plan_change_params.rbi

@@ -14,6 +14,9 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       sig do
         returns(
           Orb::SubscriptionSchedulePlanChangeParams::ChangeOption::OrSymbol
@@ -208,6 +211,7 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           change_option:
             Orb::SubscriptionSchedulePlanChangeParams::ChangeOption::OrSymbol,
           add_adjustments:
@@ -273,6 +277,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         change_option:,
         # Additional adjustments to be added to the subscription. (Only available for
         # accounts that have migrated off of legacy subscription overrides)
@@ -362,6 +367,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             change_option:
               Orb::SubscriptionSchedulePlanChangeParams::ChangeOption::OrSymbol,
             add_adjustments:

data/rbi/orb/models/subscription_trigger_phase_params.rbi

@@ -11,6 +11,9 @@ module Orb
           T.any(Orb::SubscriptionTriggerPhaseParams, Orb::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # If false, this request will fail if it would void an issued invoice or create a
       # credit note. Consider using this as a safety mechanism if you do not expect
       # existing invoices to be changed.
@@ -24,12 +27,14 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
           effective_date: T.nilable(Date),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # If false, this request will fail if it would void an issued invoice or create a
         # credit note. Consider using this as a safety mechanism if you do not expect
         # existing invoices to be changed.
@@ -44,6 +49,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             allow_invoice_credit_or_void: T.nilable(T::Boolean),
             effective_date: T.nilable(Date),
             request_options: Orb::RequestOptions

data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi

@@ -14,15 +14,23 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          subscription_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(subscription_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { subscription_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi

@@ -14,17 +14,22 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # Price for which the updates should be cleared. Must be a fixed fee.
       sig { returns(String) }
       attr_accessor :price_id
 
       sig do
         params(
+          subscription_id: String,
           price_id: String,
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # Price for which the updates should be cleared. Must be a fixed fee.
         price_id:,
         request_options: {}
@@ -33,7 +38,11 @@ module Orb
 
       sig do
         override.returns(
-          { price_id: String, request_options: Orb::RequestOptions }
+          {
+            subscription_id: String,
+            price_id: String,
+            request_options: Orb::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi

@@ -14,15 +14,23 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       sig do
-        params(request_options: Orb::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          subscription_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(subscription_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Orb::RequestOptions }) }
+      sig do
+        override.returns(
+          { subscription_id: String, request_options: Orb::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi

@@ -14,6 +14,9 @@ module Orb
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
       # Price for which the quantity should be updated. Must be a fixed fee.
       sig { returns(String) }
       attr_accessor :price_id
@@ -55,6 +58,7 @@ module Orb
 
       sig do
         params(
+          subscription_id: String,
           price_id: String,
           quantity: Float,
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
@@ -65,6 +69,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        subscription_id:,
         # Price for which the quantity should be updated. Must be a fixed fee.
         price_id:,
         quantity:,
@@ -87,6 +92,7 @@ module Orb
       sig do
         override.returns(
           {
+            subscription_id: String,
             price_id: String,
             quantity: Float,
             allow_invoice_credit_or_void: T.nilable(T::Boolean),