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-4ad3b44ca7f484243d8706b6aa7f4498fc5bf2b37fadf3da0a06d657e482c08f.yml
-openapi_spec_hash: 9ead1a2aae36be1086c627c3636064ea
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-e639b12e0daebce74f42d1f31f675bda4287b9c749dd7d4620a1e96a83343ec4.yml
+openapi_spec_hash: 51eb3d47b25e299de670b2d52f5e9017
 config_hash: e6db17547fe854b1c240407cf4c6dc9e

lib/orb/models/plan.rb

@@ -17,13 +17,19 @@ class Plan < Orb::Internal::Type::BaseModel
       required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Plan::Adjustment] }
 
       # @!attribute base_plan
+      #   @deprecated
+      #
+      #   Legacy field representing the parent plan if the current plan is a 'child plan',
+      #   overriding prices from the parent.
       #
       #   @return [Orb::Models::Plan::BasePlan, nil]
       required :base_plan, -> { Orb::Plan::BasePlan }, nil?: true
 
       # @!attribute base_plan_id
-      #   The parent plan id if the given plan was created by overriding one or more of
-      #   the parent's prices
+      #   @deprecated
+      #
+      #   Legacy field representing the parent plan ID if the current plan is a 'child
+      #   plan', overriding prices from the parent.
       #
       #   @return [String, nil]
       required :base_plan_id, String, nil?: true
@@ -168,9 +174,9 @@ class Plan < Orb::Internal::Type::BaseModel
       #
       #   @param adjustments [Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
       #
-      #   @param base_plan [Orb::Models::Plan::BasePlan, nil]
+      #   @param base_plan [Orb::Models::Plan::BasePlan, nil] Legacy field representing the parent plan if the current plan is a 'child plan',
       #
-      #   @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th
+      #   @param base_plan_id [String, nil] Legacy field representing the parent plan ID if the current plan is a 'child pla
       #
       #   @param created_at [Time]
       #
@@ -231,6 +237,8 @@ module Adjustment
         #   @return [Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)]
       end
 
+      # @deprecated
+      #
       # @see Orb::Models::Plan#base_plan
       class BasePlan < Orb::Internal::Type::BaseModel
         # @!attribute id
@@ -255,6 +263,9 @@ class BasePlan < Orb::Internal::Type::BaseModel
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Plan::BasePlan} for more details.
         #
+        #   Legacy field representing the parent plan if the current plan is a 'child plan',
+        #   overriding prices from the parent.
+        #
         #   @param id [String, nil]
         #
         #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a

lib/orb/models/subscription_price_intervals_params.rb

@@ -1591,8 +1591,8 @@ class Edit < Orb::Internal::Type::BaseModel
 
         # @!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.
+        #   final line item until the next scheduled invoice. If false, it will be billed on
+        #   its end date. If not provided, behavior will follow account default.
         #
         #   @return [Boolean, nil]
         optional :can_defer_billing, Orb::Internal::Type::Boolean, nil?: true

rbi/orb/models/plan.rbi

@@ -13,14 +13,16 @@ module Orb
       sig { returns(T::Array[Orb::Plan::Adjustment::Variants]) }
       attr_accessor :adjustments
 
+      # Legacy field representing the parent plan if the current plan is a 'child plan',
+      # overriding prices from the parent.
       sig { returns(T.nilable(Orb::Plan::BasePlan)) }
       attr_reader :base_plan
 
       sig { params(base_plan: T.nilable(Orb::Plan::BasePlan::OrHash)).void }
       attr_writer :base_plan
 
-      # The parent plan id if the given plan was created by overriding one or more of
-      # the parent's prices
+      # Legacy field representing the parent plan ID if the current plan is a 'child
+      # plan', overriding prices from the parent.
       sig { returns(T.nilable(String)) }
       attr_accessor :base_plan_id
 
@@ -205,9 +207,11 @@ module Orb
         # Adjustments for this plan. If the plan has phases, this includes adjustments
         # across all phases of the plan.
         adjustments:,
+        # Legacy field representing the parent plan if the current plan is a 'child plan',
+        # overriding prices from the parent.
         base_plan:,
-        # The parent plan id if the given plan was created by overriding one or more of
-        # the parent's prices
+        # Legacy field representing the parent plan ID if the current plan is a 'child
+        # plan', overriding prices from the parent.
         base_plan_id:,
         created_at:,
         # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
@@ -320,6 +324,8 @@ module Orb
         sig { returns(T.nilable(String)) }
         attr_accessor :name
 
+        # Legacy field representing the parent plan if the current plan is a 'child plan',
+        # overriding prices from the parent.
         sig do
           params(
             id: T.nilable(String),

rbi/orb/models/subscription_price_intervals_params.rbi

@@ -2799,8 +2799,8 @@ module Orb
         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.
+        # final line item until the next scheduled invoice. If false, it will be billed on
+        # its end date. If not provided, behavior will follow account default.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :can_defer_billing
 
@@ -2885,8 +2885,8 @@ module Orb
           # 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.
+          # final line item until the next scheduled invoice. If false, it will be billed on
+          # its end date. If not provided, behavior will 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.