orb-billing 0.2.0 → 0.3.0

data/lib/orb/models/subscription.rb

@@ -198,87 +198,92 @@ module Orb
       #   @return [Orb::Models::Subscription::TrialInfo]
       required :trial_info, -> { Orb::Models::Subscription::TrialInfo }
 
-      # @!parse
-      #   # A [subscription](/core-concepts#subscription) represents the purchase of a plan
-      #   # by a customer.
-      #   #
-      #   # By default, subscriptions begin on the day that they're created and renew
-      #   # automatically for each billing cycle at the cadence that's configured in the
-      #   # plan definition.
-      #   #
-      #   # Subscriptions also default to **beginning of month alignment**, which means the
-      #   # first invoice issued for the subscription will have pro-rated charges between
-      #   # the `start_date` and the first of the following month. Subsequent billing
-      #   # periods will always start and end on a month boundary (e.g. subsequent month
-      #   # starts for monthly billing).
-      #   #
-      #   # Depending on the plan configuration, any _flat_ recurring fees will be billed
-      #   # either at the beginning (in-advance) or end (in-arrears) of each billing cycle.
-      #   # Plans default to **in-advance billing**. Usage-based fees are billed in arrears
-      #   # as usage is accumulated. In the normal course of events, you can expect an
-      #   # invoice to contain usage-based charges for the previous period, and a recurring
-      #   # fee for the following period.
-      #   #
-      #   # @param id [String]
-      #   # @param active_plan_phase_order [Integer, nil]
-      #   # @param adjustment_intervals [Array<Orb::Models::Subscription::AdjustmentInterval>]
-      #   # @param auto_collection [Boolean, nil]
-      #   # @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
-      #   # @param billing_cycle_day [Integer]
-      #   # @param created_at [Time]
-      #   # @param current_billing_period_end_date [Time, nil]
-      #   # @param current_billing_period_start_date [Time, nil]
-      #   # @param customer [Orb::Models::Customer]
-      #   # @param default_invoice_memo [String, nil]
-      #   # @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval>]
-      #   # @param end_date [Time, nil]
-      #   # @param fixed_fee_quantity_schedule [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
-      #   # @param invoicing_threshold [String, nil]
-      #   # @param maximum_intervals [Array<Orb::Models::Subscription::MaximumInterval>]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param minimum_intervals [Array<Orb::Models::Subscription::MinimumInterval>]
-      #   # @param net_terms [Integer]
-      #   # @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil]
-      #   # @param plan [Orb::Models::Plan]
-      #   # @param price_intervals [Array<Orb::Models::Subscription::PriceInterval>]
-      #   # @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil]
-      #   # @param start_date [Time]
-      #   # @param status [Symbol, Orb::Models::Subscription::Status]
-      #   # @param trial_info [Orb::Models::Subscription::TrialInfo]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     active_plan_phase_order:,
-      #     adjustment_intervals:,
-      #     auto_collection:,
-      #     billing_cycle_anchor_configuration:,
-      #     billing_cycle_day:,
-      #     created_at:,
-      #     current_billing_period_end_date:,
-      #     current_billing_period_start_date:,
-      #     customer:,
-      #     default_invoice_memo:,
-      #     discount_intervals:,
-      #     end_date:,
-      #     fixed_fee_quantity_schedule:,
-      #     invoicing_threshold:,
-      #     maximum_intervals:,
-      #     metadata:,
-      #     minimum_intervals:,
-      #     net_terms:,
-      #     pending_subscription_change:,
-      #     plan:,
-      #     price_intervals:,
-      #     redeemed_coupon:,
-      #     start_date:,
-      #     status:,
-      #     trial_info:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::Subscription} for more details.
+      #
+      #   A [subscription](/core-concepts#subscription) represents the purchase of a plan
+      #   by a customer.
+      #
+      #   By default, subscriptions begin on the day that they're created and renew
+      #   automatically for each billing cycle at the cadence that's configured in the
+      #   plan definition.
+      #
+      #   Subscriptions also default to **beginning of month alignment**, which means the
+      #   first invoice issued for the subscription will have pro-rated charges between
+      #   the `start_date` and the first of the following month. Subsequent billing
+      #   periods will always start and end on a month boundary (e.g. subsequent month
+      #   starts for monthly billing).
+      #
+      #   Depending on the plan configuration, any _flat_ recurring fees will be billed
+      #   either at the beginning (in-advance) or end (in-arrears) of each billing cycle.
+      #   Plans default to **in-advance billing**. Usage-based fees are billed in arrears
+      #   as usage is accumulated. In the normal course of events, you can expect an
+      #   invoice to contain usage-based charges for the previous period, and a recurring
+      #   fee for the following period.
+      #
+      #   @param id [String]
+      #
+      #   @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
+      #   ...
+      #
+      #   @param adjustment_intervals [Array<Orb::Models::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
+      #   ...
+      #
+      #   @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
+      #   ...
+      #
+      #   @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
+      #
+      #   @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
+      #   ...
+      #
+      #   @param created_at [Time]
+      #
+      #   @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
+      #   ...
+      #
+      #   @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
+      #   ...
+      #
+      #   @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
+      #   ...
+      #
+      #   @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
+      #
+      #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
+      #
+      #   @param fixed_fee_quantity_schedule [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
+      #
+      #   @param invoicing_threshold [String, nil]
+      #
+      #   @param maximum_intervals [Array<Orb::Models::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #   ...
+      #
+      #   @param minimum_intervals [Array<Orb::Models::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
+      #
+      #   @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
+      #   ...
+      #
+      #   @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
+      #
+      #   @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      #   ...
+      #
+      #   @param price_intervals [Array<Orb::Models::Subscription::PriceInterval>] The price intervals for this subscription.
+      #
+      #   @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil]
+      #
+      #   @param start_date [Time] The date Orb starts billing for this subscription.
+      #
+      #   @param status [Symbol, Orb::Models::Subscription::Status]
+      #
+      #   @param trial_info [Orb::Models::Subscription::TrialInfo]
 
       class AdjustmentInterval < Orb::Internal::Type::BaseModel
         # @!attribute id
@@ -309,16 +314,16 @@ module Orb
         #   @return [Time]
         required :start_date, Time
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
-        #   # @param applies_to_price_interval_ids [Array<String>]
-        #   # @param end_date [Time, nil]
-        #   # @param start_date [Time]
-        #   #
-        #   def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
+        #   @param id [String]
+        #
+        #   @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
+        #
+        #   @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
+        #
+        #   @param end_date [Time, nil] The end date of the adjustment interval.
+        #
+        #   @param start_date [Time] The start date of the adjustment interval.
 
         # @see Orb::Models::Subscription::AdjustmentInterval#adjustment
         module Adjustment
@@ -384,29 +389,26 @@ module Orb
             #   @return [Float]
             required :usage_discount, Float
 
-            # @!parse
-            #   # @param id [String]
-            #   # @param applies_to_price_ids [Array<String>]
-            #   # @param is_invoice_level [Boolean]
-            #   # @param plan_phase_order [Integer, nil]
-            #   # @param reason [String, nil]
-            #   # @param usage_discount [Float]
-            #   # @param adjustment_type [Symbol, :usage_discount]
-            #   #
-            #   def initialize(
-            #     id:,
-            #     applies_to_price_ids:,
-            #     is_invoice_level:,
-            #     plan_phase_order:,
-            #     reason:,
-            #     usage_discount:,
-            #     adjustment_type: :usage_discount,
-            #     **
-            #   )
-            #     super
-            #   end
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment}
+            #   for more details.
+            #
+            #   @param id [String]
+            #
+            #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+            #
+            #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+            #   ...
+            #
+            #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+            #
+            #   @param reason [String, nil] The reason for the adjustment.
+            #
+            #   @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
+            #   ...
+            #
+            #   @param adjustment_type [Symbol, :usage_discount]
           end
 
           class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
@@ -452,29 +454,26 @@ module Orb
             #   @return [String, nil]
             required :reason, String, nil?: true
 
-            # @!parse
-            #   # @param id [String]
-            #   # @param amount_discount [String]
-            #   # @param applies_to_price_ids [Array<String>]
-            #   # @param is_invoice_level [Boolean]
-            #   # @param plan_phase_order [Integer, nil]
-            #   # @param reason [String, nil]
-            #   # @param adjustment_type [Symbol, :amount_discount]
-            #   #
-            #   def initialize(
-            #     id:,
-            #     amount_discount:,
-            #     applies_to_price_ids:,
-            #     is_invoice_level:,
-            #     plan_phase_order:,
-            #     reason:,
-            #     adjustment_type: :amount_discount,
-            #     **
-            #   )
-            #     super
-            #   end
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment}
+            #   for more details.
+            #
+            #   @param id [String]
+            #
+            #   @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
+            #   ...
+            #
+            #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+            #
+            #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+            #   ...
+            #
+            #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+            #
+            #   @param reason [String, nil] The reason for the adjustment.
+            #
+            #   @param adjustment_type [Symbol, :amount_discount]
           end
 
           class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
@@ -520,29 +519,26 @@ module Orb
             #   @return [String, nil]
             required :reason, String, nil?: true
 
-            # @!parse
-            #   # @param id [String]
-            #   # @param applies_to_price_ids [Array<String>]
-            #   # @param is_invoice_level [Boolean]
-            #   # @param percentage_discount [Float]
-            #   # @param plan_phase_order [Integer, nil]
-            #   # @param reason [String, nil]
-            #   # @param adjustment_type [Symbol, :percentage_discount]
-            #   #
-            #   def initialize(
-            #     id:,
-            #     applies_to_price_ids:,
-            #     is_invoice_level:,
-            #     percentage_discount:,
-            #     plan_phase_order:,
-            #     reason:,
-            #     adjustment_type: :percentage_discount,
-            #     **
-            #   )
-            #     super
-            #   end
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment}
+            #   for more details.
+            #
+            #   @param id [String]
+            #
+            #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+            #
+            #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+            #   ...
+            #
+            #   @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
+            #   ...
+            #
+            #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+            #
+            #   @param reason [String, nil] The reason for the adjustment.
+            #
+            #   @param adjustment_type [Symbol, :percentage_discount]
           end
 
           class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
@@ -594,31 +590,28 @@ module Orb
             #   @return [String, nil]
             required :reason, String, nil?: true
 
-            # @!parse
-            #   # @param id [String]
-            #   # @param applies_to_price_ids [Array<String>]
-            #   # @param is_invoice_level [Boolean]
-            #   # @param item_id [String]
-            #   # @param minimum_amount [String]
-            #   # @param plan_phase_order [Integer, nil]
-            #   # @param reason [String, nil]
-            #   # @param adjustment_type [Symbol, :minimum]
-            #   #
-            #   def initialize(
-            #     id:,
-            #     applies_to_price_ids:,
-            #     is_invoice_level:,
-            #     item_id:,
-            #     minimum_amount:,
-            #     plan_phase_order:,
-            #     reason:,
-            #     adjustment_type: :minimum,
-            #     **
-            #   )
-            #     super
-            #   end
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment}
+            #   for more details.
+            #
+            #   @param id [String]
+            #
+            #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+            #
+            #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+            #   ...
+            #
+            #   @param item_id [String] The item ID that revenue from this minimum will be attributed to.
+            #
+            #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
+            #   ...
+            #
+            #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+            #
+            #   @param reason [String, nil] The reason for the adjustment.
+            #
+            #   @param adjustment_type [Symbol, :minimum]
           end
 
           class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
@@ -664,34 +657,30 @@ module Orb
             #   @return [String, nil]
             required :reason, String, nil?: true
 
-            # @!parse
-            #   # @param id [String]
-            #   # @param applies_to_price_ids [Array<String>]
-            #   # @param is_invoice_level [Boolean]
-            #   # @param maximum_amount [String]
-            #   # @param plan_phase_order [Integer, nil]
-            #   # @param reason [String, nil]
-            #   # @param adjustment_type [Symbol, :maximum]
-            #   #
-            #   def initialize(
-            #     id:,
-            #     applies_to_price_ids:,
-            #     is_invoice_level:,
-            #     maximum_amount:,
-            #     plan_phase_order:,
-            #     reason:,
-            #     adjustment_type: :maximum,
-            #     **
-            #   )
-            #     super
-            #   end
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment}
+            #   for more details.
+            #
+            #   @param id [String]
+            #
+            #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+            #
+            #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+            #   ...
+            #
+            #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
+            #   ...
+            #
+            #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+            #
+            #   @param reason [String, nil] The reason for the adjustment.
+            #
+            #   @param adjustment_type [Symbol, :maximum]
           end
 
-          # @!parse
-          #   # @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
-          #   def self.variants; end
+          # @!method self.variants
+          #   @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
         end
       end
 
@@ -721,14 +710,18 @@ module Orb
         #   @return [Integer, nil]
         optional :year, Integer, nil?: true
 
-        # @!parse
-        #   # @param day [Integer]
-        #   # @param month [Integer, nil]
-        #   # @param year [Integer, nil]
-        #   #
-        #   def initialize(day:, month: nil, year: nil, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(day:, month: nil, year: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Subscription::BillingCycleAnchorConfiguration} for more details.
+        #
+        #   @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
+        #   ...
+        #
+        #   @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
+        #   ...
+        #
+        #   @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
+        #   ...
       end
 
       module DiscountInterval
@@ -778,27 +771,18 @@ module Orb
           #   @return [Time]
           required :start_date, Time
 
-          # @!parse
-          #   # @param amount_discount [String]
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param applies_to_price_interval_ids [Array<String>]
-          #   # @param end_date [Time, nil]
-          #   # @param start_date [Time]
-          #   # @param discount_type [Symbol, :amount]
-          #   #
-          #   def initialize(
-          #     amount_discount:,
-          #     applies_to_price_ids:,
-          #     applies_to_price_interval_ids:,
-          #     end_date:,
-          #     start_date:,
-          #     discount_type: :amount,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
+          #   @param amount_discount [String] Only available if discount_type is `amount`.
+          #
+          #   @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
+          #
+          #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
+          #
+          #   @param end_date [Time, nil] The end date of the discount interval.
+          #
+          #   @param start_date [Time] The start date of the discount interval.
+          #
+          #   @param discount_type [Symbol, :amount]
         end
 
         class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
@@ -838,27 +822,23 @@ module Orb
           #   @return [Time]
           required :start_date, Time
 
-          # @!parse
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param applies_to_price_interval_ids [Array<String>]
-          #   # @param end_date [Time, nil]
-          #   # @param percentage_discount [Float]
-          #   # @param start_date [Time]
-          #   # @param discount_type [Symbol, :percentage]
-          #   #
-          #   def initialize(
-          #     applies_to_price_ids:,
-          #     applies_to_price_interval_ids:,
-          #     end_date:,
-          #     percentage_discount:,
-          #     start_date:,
-          #     discount_type: :percentage,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval} for
+          #   more details.
+          #
+          #   @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
+          #
+          #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
+          #
+          #   @param end_date [Time, nil] The end date of the discount interval.
+          #
+          #   @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
+          #   ...
+          #
+          #   @param start_date [Time] The start date of the discount interval.
+          #
+          #   @param discount_type [Symbol, :percentage]
         end
 
         class UsageDiscountInterval < Orb::Internal::Type::BaseModel
@@ -898,32 +878,27 @@ module Orb
           #   @return [Float]
           required :usage_discount, Float
 
-          # @!parse
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param applies_to_price_interval_ids [Array<String>]
-          #   # @param end_date [Time, nil]
-          #   # @param start_date [Time]
-          #   # @param usage_discount [Float]
-          #   # @param discount_type [Symbol, :usage]
-          #   #
-          #   def initialize(
-          #     applies_to_price_ids:,
-          #     applies_to_price_interval_ids:,
-          #     end_date:,
-          #     start_date:,
-          #     usage_discount:,
-          #     discount_type: :usage,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval} for more
+          #   details.
+          #
+          #   @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
+          #
+          #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
+          #
+          #   @param end_date [Time, nil] The end date of the discount interval.
+          #
+          #   @param start_date [Time] The start date of the discount interval.
+          #
+          #   @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
+          #   ...
+          #
+          #   @param discount_type [Symbol, :usage]
         end
 
-        # @!parse
-        #   # @return [Array(Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval)]
-        #   def self.variants; end
+        # @!method self.variants
+        #   @return [Array(Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval)]
       end
 
       class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -947,15 +922,11 @@ module Orb
         #   @return [Time]
         required :start_date, Time
 
-        # @!parse
-        #   # @param end_date [Time, nil]
-        #   # @param price_id [String]
-        #   # @param quantity [Float]
-        #   # @param start_date [Time]
-        #   #
-        #   def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(end_date:, price_id:, quantity:, start_date:)
+        #   @param end_date [Time, nil]
+        #   @param price_id [String]
+        #   @param quantity [Float]
+        #   @param start_date [Time]
       end
 
       class MaximumInterval < Orb::Internal::Type::BaseModel
@@ -990,16 +961,20 @@ module Orb
         #   @return [Time]
         required :start_date, Time
 
-        # @!parse
-        #   # @param applies_to_price_ids [Array<String>]
-        #   # @param applies_to_price_interval_ids [Array<String>]
-        #   # @param end_date [Time, nil]
-        #   # @param maximum_amount [String]
-        #   # @param start_date [Time]
-        #   #
-        #   def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Subscription::MaximumInterval} for more details.
+        #
+        #   @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
+        #
+        #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
+        #
+        #   @param end_date [Time, nil] The end date of the maximum interval.
+        #
+        #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
+        #   ...
+        #
+        #   @param start_date [Time] The start date of the maximum interval.
       end
 
       class MinimumInterval < Orb::Internal::Type::BaseModel
@@ -1034,16 +1009,20 @@ module Orb
         #   @return [Time]
         required :start_date, Time
 
-        # @!parse
-        #   # @param applies_to_price_ids [Array<String>]
-        #   # @param applies_to_price_interval_ids [Array<String>]
-        #   # @param end_date [Time, nil]
-        #   # @param minimum_amount [String]
-        #   # @param start_date [Time]
-        #   #
-        #   def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Subscription::MinimumInterval} for more details.
+        #
+        #   @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
+        #
+        #   @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
+        #
+        #   @param end_date [Time, nil] The end date of the minimum interval.
+        #
+        #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
+        #   ...
+        #
+        #   @param start_date [Time] The start date of the minimum interval.
       end
 
       # @see Orb::Models::Subscription#pending_subscription_change
@@ -1053,14 +1032,10 @@ module Orb
         #   @return [String]
         required :id, String
 
-        # @!parse
-        #   # A pending subscription change if one exists on this subscription.
-        #   #
-        #   # @param id [String]
-        #   #
-        #   def initialize(id:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:)
+        #   A pending subscription change if one exists on this subscription.
+        #
+        #   @param id [String]
       end
 
       class PriceInterval < Orb::Internal::Type::BaseModel
@@ -1142,39 +1117,40 @@ module Orb
         #   @return [Array<String>, nil]
         required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
-        # @!parse
-        #   # The Price Interval resource represents a period of time for which a price will
-        #   # bill on a subscription. A subscription’s price intervals define its billing
-        #   # behavior.
-        #   #
-        #   # @param id [String]
-        #   # @param billing_cycle_day [Integer]
-        #   # @param current_billing_period_end_date [Time, nil]
-        #   # @param current_billing_period_start_date [Time, nil]
-        #   # @param end_date [Time, nil]
-        #   # @param filter [String, nil]
-        #   # @param fixed_fee_quantity_transitions [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
-        #   # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
-        #   # @param start_date [Time]
-        #   # @param usage_customer_ids [Array<String>, nil]
-        #   #
-        #   def 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:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!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:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Subscription::PriceInterval} for more details.
+        #
+        #   The Price Interval resource represents a period of time for which a price will
+        #   bill on a subscription. A subscription’s price intervals define its billing
+        #   behavior.
+        #
+        #   @param id [String]
+        #
+        #   @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
+        #
+        #   @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
+        #   ...
+        #
+        #   @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
+        #   ...
+        #
+        #   @param filter [String, nil] An additional filter to apply to usage queries.
+        #
+        #   @param fixed_fee_quantity_transitions [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
+        #   ...
+        #
+        #   @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu
+        #   ...
+        #
+        #   @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
+        #   ...
+        #
+        #   @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
+        #   ...
 
         class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
           # @!attribute effective_date
@@ -1192,14 +1168,10 @@ module Orb
           #   @return [Integer]
           required :quantity, Integer
 
-          # @!parse
-          #   # @param effective_date [Time]
-          #   # @param price_id [String]
-          #   # @param quantity [Integer]
-          #   #
-          #   def initialize(effective_date:, price_id:, quantity:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(effective_date:, price_id:, quantity:)
+          #   @param effective_date [Time]
+          #   @param price_id [String]
+          #   @param quantity [Integer]
         end
       end
 
@@ -1220,14 +1192,10 @@ module Orb
         #   @return [Time]
         required :start_date, Time
 
-        # @!parse
-        #   # @param coupon_id [String]
-        #   # @param end_date [Time, nil]
-        #   # @param start_date [Time]
-        #   #
-        #   def initialize(coupon_id:, end_date:, start_date:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(coupon_id:, end_date:, start_date:)
+        #   @param coupon_id [String]
+        #   @param end_date [Time, nil]
+        #   @param start_date [Time]
       end
 
       # @see Orb::Models::Subscription#status
@@ -1238,11 +1206,8 @@ module Orb
         ENDED = :ended
         UPCOMING = :upcoming
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # @see Orb::Models::Subscription#trial_info
@@ -1252,12 +1217,8 @@ module Orb
         #   @return [Time, nil]
         required :end_date, Time, nil?: true
 
-        # @!parse
-        #   # @param end_date [Time, nil]
-        #   #
-        #   def initialize(end_date:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(end_date:)
+        #   @param end_date [Time, nil]
       end
     end
   end