feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-5b9152241ebdd0d2f3fd536784f33721d24a5c4a59e75cab366a3dcb36552d3d.yml
-openapi_spec_hash: b40061d10bbe1ebab8998bddd1827cf8
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-f2b97a2c3e41f618dc8955ed325092320ff2170a7d7a9a26a31dc235c969b657.yml
+openapi_spec_hash: 64548564dc8ce80ef3ad38fc8cb56b30
 config_hash: dd4343ce95871032ef6e0735a4ca038c

lib/orb/models/price_interval.rb

@@ -14,6 +14,14 @@ class PriceInterval < Orb::Internal::Type::BaseModel
       #   @return [Integer]
       required :billing_cycle_day, Integer
 
+      # @!attribute can_defer_billing
+      #   For in-arrears prices. If true, and the price interval ends mid-cycle, the final
+      #   line item will be deferred to the next scheduled invoice instead of being billed
+      #   mid-cycle.
+      #
+      #   @return [Boolean]
+      required :can_defer_billing, Orb::Internal::Type::Boolean
+
       # @!attribute current_billing_period_end_date
       #   The end of the current billing period. This is an exclusive timestamp, such that
       #   the instant returned is exactly the end of the billing period. Set to null if
@@ -81,7 +89,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel
       #   @return [Array<String>, nil]
       required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
-      # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
+      # @!method initialize(id:, billing_cycle_day:, can_defer_billing:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PriceInterval} for more details.
       #
@@ -93,6 +101,8 @@ class PriceInterval < Orb::Internal::Type::BaseModel
       #
       #   @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
       #
+      #   @param can_defer_billing [Boolean] For in-arrears prices. If true, and the price interval ends mid-cycle, the final
+      #
       #   @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
       #
       #   @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th

lib/orb/models/subscription_price_intervals_params.rb

@@ -28,6 +28,14 @@ class SubscriptionPriceIntervalsParams < Orb::Internal::Type::BaseModel
       #   @return [Boolean, nil]
       optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true
 
+      # @!attribute can_defer_billing
+      #   If true, ending an in-arrears price interval mid-cycle will defer billing the
+      #   final line itemuntil the next scheduled invoice. If false, it will be billed on
+      #   its end date. If not provided, behaviorwill follow account default.
+      #
+      #   @return [Boolean, nil]
+      optional :can_defer_billing, Orb::Internal::Type::Boolean, nil?: true
+
       # @!attribute edit
       #   A list of price intervals to edit on the subscription.
       #
@@ -41,7 +49,7 @@ class SubscriptionPriceIntervalsParams < Orb::Internal::Type::BaseModel
       optional :edit_adjustments,
                -> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::EditAdjustment] }
 
-      # @!method initialize(add: nil, add_adjustments: nil, allow_invoice_credit_or_void: nil, edit: nil, edit_adjustments: nil, request_options: {})
+      # @!method initialize(add: nil, add_adjustments: nil, allow_invoice_credit_or_void: nil, can_defer_billing: nil, edit: nil, edit_adjustments: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionPriceIntervalsParams} for more details.
       #
@@ -51,6 +59,8 @@ class SubscriptionPriceIntervalsParams < Orb::Internal::Type::BaseModel
       #
       #   @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
       #
+      #   @param can_defer_billing [Boolean, nil] If true, ending an in-arrears price interval mid-cycle will defer billing the fi
+      #
       #   @param edit [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit>] A list of price intervals to edit on the subscription.
       #
       #   @param edit_adjustments [Array<Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment>] A list of adjustments to edit on the subscription.
@@ -1361,6 +1371,14 @@ class Edit < Orb::Internal::Type::BaseModel
         #   @return [Integer, nil]
         optional :billing_cycle_day, Integer, nil?: true
 
+        # @!attribute can_defer_billing
+        #   If true, ending an in-arrears price interval mid-cycle will defer billing the
+        #   final line itemuntil the next scheduled invoice. If false, it will be billed on
+        #   its end date. If not provided, behaviorwill follow account default.
+        #
+        #   @return [Boolean, nil]
+        optional :can_defer_billing, Orb::Internal::Type::Boolean, nil?: true
+
         # @!attribute end_date
         #   The updated end date of this price interval. If not specified, the end date will
         #   not be updated.
@@ -1407,14 +1425,16 @@ class Edit < Orb::Internal::Type::BaseModel
         #   @return [Array<String>, nil]
         optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
-        # @!method initialize(price_interval_id:, billing_cycle_day: nil, end_date: nil, filter: nil, fixed_fee_quantity_transitions: nil, start_date: nil, usage_customer_ids: nil)
+        # @!method initialize(price_interval_id:, billing_cycle_day: nil, can_defer_billing: nil, end_date: nil, filter: nil, fixed_fee_quantity_transitions: nil, start_date: nil, usage_customer_ids: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionPriceIntervalsParams::Edit} for more details.
         #
         #   @param price_interval_id [String] The id of the price interval to edit.
         #
         #   @param billing_cycle_day [Integer, nil] The updated billing cycle day for this price interval. If not specified, the bil
         #
+        #   @param can_defer_billing [Boolean, nil] If true, ending an in-arrears price interval mid-cycle will defer billing the fi
+        #
         #   @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this price interval. If not specified, the end date will
         #
         #   @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as

lib/orb/models/tiered_config.rb

@@ -9,10 +9,18 @@ class TieredConfig < Orb::Internal::Type::BaseModel
       #   @return [Array<Orb::Models::Tier>]
       required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Tier] }
 
-      # @!method initialize(tiers:)
+      # @!attribute prorated
+      #   If true, subtotals from this price are prorated based on the service period
+      #
+      #   @return [Boolean, nil]
+      optional :prorated, Orb::Internal::Type::Boolean
+
+      # @!method initialize(tiers:, prorated: nil)
       #   Configuration for tiered pricing
       #
       #   @param tiers [Array<Orb::Models::Tier>] Tiers for rating based on total usage quantities into the specified tier
+      #
+      #   @param prorated [Boolean] If true, subtotals from this price are prorated based on the service period
     end
   end
 end

lib/orb/models/unit_config.rb

@@ -9,10 +9,18 @@ class UnitConfig < Orb::Internal::Type::BaseModel
       #   @return [String]
       required :unit_amount, String
 
-      # @!method initialize(unit_amount:)
+      # @!attribute prorated
+      #   If true, subtotals from this price are prorated based on the service period
+      #
+      #   @return [Boolean, nil]
+      optional :prorated, Orb::Internal::Type::Boolean
+
+      # @!method initialize(unit_amount:, prorated: nil)
       #   Configuration for unit pricing
       #
       #   @param unit_amount [String] Rate per unit of usage
+      #
+      #   @param prorated [Boolean] If true, subtotals from this price are prorated based on the service period
     end
   end
 end

lib/orb/resources/subscriptions.rb

@@ -956,7 +956,7 @@ def fetch_usage(subscription_id, params = {})
       # `fixed_fee_quantity_transitions` property on a subscription’s serialized price
       # intervals.
       #
-      # @overload price_intervals(subscription_id, add: nil, add_adjustments: nil, allow_invoice_credit_or_void: nil, edit: nil, edit_adjustments: nil, request_options: {})
+      # @overload price_intervals(subscription_id, add: nil, add_adjustments: nil, allow_invoice_credit_or_void: nil, can_defer_billing: nil, edit: nil, edit_adjustments: nil, request_options: {})
       #
       # @param subscription_id [String]
       #
@@ -966,6 +966,8 @@ def fetch_usage(subscription_id, params = {})
       #
       # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
       #
+      # @param can_defer_billing [Boolean, nil] If true, ending an in-arrears price interval mid-cycle will defer billing the fi
+      #
       # @param edit [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit>] A list of price intervals to edit on the subscription.
       #
       # @param edit_adjustments [Array<Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment>] A list of adjustments to edit on the subscription.

rbi/orb/models/price_interval.rbi

@@ -13,6 +13,12 @@ module Orb
       sig { returns(Integer) }
       attr_accessor :billing_cycle_day
 
+      # For in-arrears prices. If true, and the price interval ends mid-cycle, the final
+      # line item will be deferred to the next scheduled invoice instead of being billed
+      # mid-cycle.
+      sig { returns(T::Boolean) }
+      attr_accessor :can_defer_billing
+
       # The end of the current billing period. This is an exclusive timestamp, such that
       # the instant returned is exactly the end of the billing period. Set to null if
       # this price interval is not currently active.
@@ -69,6 +75,7 @@ module Orb
         params(
           id: String,
           billing_cycle_day: Integer,
+          can_defer_billing: T::Boolean,
           current_billing_period_end_date: T.nilable(Time),
           current_billing_period_start_date: T.nilable(Time),
           end_date: T.nilable(Time),
@@ -116,6 +123,10 @@ module Orb
         id:,
         # The day of the month that Orb bills for this price
         billing_cycle_day:,
+        # For in-arrears prices. If true, and the price interval ends mid-cycle, the final
+        # line item will be deferred to the next scheduled invoice instead of being billed
+        # mid-cycle.
+        can_defer_billing:,
         # The end of the current billing period. This is an exclusive timestamp, such that
         # the instant returned is exactly the end of the billing period. Set to null if
         # this price interval is not currently active.
@@ -157,6 +168,7 @@ module Orb
           {
             id: String,
             billing_cycle_day: Integer,
+            can_defer_billing: T::Boolean,
             current_billing_period_end_date: T.nilable(Time),
             current_billing_period_start_date: T.nilable(Time),
             end_date: T.nilable(Time),

rbi/orb/models/subscription_price_intervals_params.rbi

@@ -50,6 +50,12 @@ module Orb
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :allow_invoice_credit_or_void
 
+      # If true, ending an in-arrears price interval mid-cycle will defer billing the
+      # final line itemuntil the next scheduled invoice. If false, it will be billed on
+      # its end date. If not provided, behaviorwill follow account default.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :can_defer_billing
+
       # A list of price intervals to edit on the subscription.
       sig do
         returns(
@@ -93,6 +99,7 @@ module Orb
               Orb::SubscriptionPriceIntervalsParams::AddAdjustment::OrHash
             ],
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
+          can_defer_billing: T.nilable(T::Boolean),
           edit: T::Array[Orb::SubscriptionPriceIntervalsParams::Edit::OrHash],
           edit_adjustments:
             T::Array[
@@ -110,6 +117,10 @@ module Orb
         # credit note. Consider using this as a safety mechanism if you do not expect
         # existing invoices to be changed.
         allow_invoice_credit_or_void: nil,
+        # If true, ending an in-arrears price interval mid-cycle will defer billing the
+        # final line itemuntil the next scheduled invoice. If false, it will be billed on
+        # its end date. If not provided, behaviorwill follow account default.
+        can_defer_billing: nil,
         # A list of price intervals to edit on the subscription.
         edit: nil,
         # A list of adjustments to edit on the subscription.
@@ -125,6 +136,7 @@ module Orb
             add_adjustments:
               T::Array[Orb::SubscriptionPriceIntervalsParams::AddAdjustment],
             allow_invoice_credit_or_void: T.nilable(T::Boolean),
+            can_defer_billing: T.nilable(T::Boolean),
             edit: T::Array[Orb::SubscriptionPriceIntervalsParams::Edit],
             edit_adjustments:
               T::Array[Orb::SubscriptionPriceIntervalsParams::EditAdjustment],
@@ -2419,6 +2431,12 @@ module Orb
         sig { returns(T.nilable(Integer)) }
         attr_accessor :billing_cycle_day
 
+        # If true, ending an in-arrears price interval mid-cycle will defer billing the
+        # final line itemuntil the next scheduled invoice. If false, it will be billed on
+        # its end date. If not provided, behaviorwill follow account default.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :can_defer_billing
+
         # The updated end date of this price interval. If not specified, the end date will
         # not be updated.
         sig do
@@ -2478,6 +2496,7 @@ module Orb
           params(
             price_interval_id: String,
             billing_cycle_day: T.nilable(Integer),
+            can_defer_billing: T.nilable(T::Boolean),
             end_date:
               T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
             filter: T.nilable(String),
@@ -2498,6 +2517,10 @@ module Orb
           # billing cycle day will not be updated. Note that overlapping price intervals
           # must have the same billing cycle day.
           billing_cycle_day: nil,
+          # If true, ending an in-arrears price interval mid-cycle will defer billing the
+          # final line itemuntil the next scheduled invoice. If false, it will be billed on
+          # its end date. If not provided, behaviorwill follow account default.
+          can_defer_billing: nil,
           # The updated end date of this price interval. If not specified, the end date will
           # not be updated.
           end_date: nil,
@@ -2528,6 +2551,7 @@ module Orb
             {
               price_interval_id: String,
               billing_cycle_day: T.nilable(Integer),
+              can_defer_billing: T.nilable(T::Boolean),
               end_date:
                 T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
               filter: T.nilable(String),

rbi/orb/models/tiered_config.rbi

@@ -9,17 +9,31 @@ module Orb
       sig { returns(T::Array[Orb::Tier]) }
       attr_accessor :tiers
 
+      # If true, subtotals from this price are prorated based on the service period
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :prorated
+
+      sig { params(prorated: T::Boolean).void }
+      attr_writer :prorated
+
       # Configuration for tiered pricing
       sig do
-        params(tiers: T::Array[Orb::Tier::OrHash]).returns(T.attached_class)
+        params(
+          tiers: T::Array[Orb::Tier::OrHash],
+          prorated: T::Boolean
+        ).returns(T.attached_class)
       end
       def self.new(
         # Tiers for rating based on total usage quantities into the specified tier
-        tiers:
+        tiers:,
+        # If true, subtotals from this price are prorated based on the service period
+        prorated: nil
       )
       end
 
-      sig { override.returns({ tiers: T::Array[Orb::Tier] }) }
+      sig do
+        override.returns({ tiers: T::Array[Orb::Tier], prorated: T::Boolean })
+      end
       def to_hash
       end
     end

rbi/orb/models/unit_config.rbi

@@ -9,15 +9,28 @@ module Orb
       sig { returns(String) }
       attr_accessor :unit_amount
 
+      # If true, subtotals from this price are prorated based on the service period
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :prorated
+
+      sig { params(prorated: T::Boolean).void }
+      attr_writer :prorated
+
       # Configuration for unit pricing
-      sig { params(unit_amount: String).returns(T.attached_class) }
+      sig do
+        params(unit_amount: String, prorated: T::Boolean).returns(
+          T.attached_class
+        )
+      end
       def self.new(
         # Rate per unit of usage
-        unit_amount:
+        unit_amount:,
+        # If true, subtotals from this price are prorated based on the service period
+        prorated: nil
       )
       end
 
-      sig { override.returns({ unit_amount: String }) }
+      sig { override.returns({ unit_amount: String, prorated: T::Boolean }) }
       def to_hash
       end
     end