orb-billing 0.1.0.pre.alpha.33

data/lib/orb/models/plan.rb

@@ -0,0 +1,894 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Plans#create
+    class Plan < Orb::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute adjustments
+      #   Adjustments for this plan. If the plan has phases, this includes adjustments
+      #     across all phases of the plan.
+      #
+      #   @return [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>]
+      required :adjustments, -> { Orb::ArrayOf[union: Orb::Models::Plan::Adjustment] }
+
+      # @!attribute base_plan
+      #
+      #   @return [Orb::Models::Plan::BasePlan, nil]
+      required :base_plan, -> { Orb::Models::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
+      #
+      #   @return [String, nil]
+      required :base_plan_id, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
+      #     prices.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute default_invoice_memo
+      #   The default memo text on the invoices corresponding to subscriptions on this
+      #     plan. Note that each subscription may configure its own memo.
+      #
+      #   @return [String, nil]
+      required :default_invoice_memo, String, nil?: true
+
+      # @!attribute description
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute discount
+      #
+      #   @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+      required :discount, union: -> { Orb::Models::Discount }, nil?: true
+
+      # @!attribute external_plan_id
+      #   An optional user-defined ID for this plan resource, used throughout the system
+      #     as an alias for this Plan. Use this field to identify a plan by an existing
+      #     identifier in your system.
+      #
+      #   @return [String, nil]
+      required :external_plan_id, String, nil?: true
+
+      # @!attribute invoicing_currency
+      #   An ISO 4217 currency string for which this plan is billed in. Matches `currency`
+      #     unless `currency` is a custom pricing unit.
+      #
+      #   @return [String]
+      required :invoicing_currency, String
+
+      # @!attribute maximum
+      #
+      #   @return [Orb::Models::Plan::Maximum, nil]
+      required :maximum, -> { Orb::Models::Plan::Maximum }, nil?: true
+
+      # @!attribute maximum_amount
+      #
+      #   @return [String, nil]
+      required :maximum_amount, String, nil?: true
+
+      # @!attribute metadata
+      #   User specified key-value pairs for the resource. If not present, this defaults
+      #     to an empty dictionary. Individual keys can be removed by setting the value to
+      #     `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+      #     `null`.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Orb::HashOf[String]
+
+      # @!attribute minimum
+      #
+      #   @return [Orb::Models::Plan::Minimum, nil]
+      required :minimum, -> { Orb::Models::Plan::Minimum }, nil?: true
+
+      # @!attribute minimum_amount
+      #
+      #   @return [String, nil]
+      required :minimum_amount, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute net_terms
+      #   Determines the difference between the invoice issue date and the due date. A
+      #     value of "0" here signifies that invoices are due on issue, whereas a value of
+      #     "30" means that the customer has a month to pay the invoice before its overdue.
+      #     Note that individual subscriptions or invoices may set a different net terms
+      #     configuration.
+      #
+      #   @return [Integer, nil]
+      required :net_terms, Integer, nil?: true
+
+      # @!attribute plan_phases
+      #
+      #   @return [Array<Orb::Models::Plan::PlanPhase>, nil]
+      required :plan_phases, -> { Orb::ArrayOf[Orb::Models::Plan::PlanPhase] }, nil?: true
+
+      # @!attribute prices
+      #   Prices for this plan. If the plan has phases, this includes prices across all
+      #     phases of the plan.
+      #
+      #   @return [Array<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>]
+      required :prices, -> { Orb::ArrayOf[union: Orb::Models::Price] }
+
+      # @!attribute product
+      #
+      #   @return [Orb::Models::Plan::Product]
+      required :product, -> { Orb::Models::Plan::Product }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Orb::Models::Plan::Status]
+      required :status, enum: -> { Orb::Models::Plan::Status }
+
+      # @!attribute trial_config
+      #
+      #   @return [Orb::Models::Plan::TrialConfig]
+      required :trial_config, -> { Orb::Models::Plan::TrialConfig }
+
+      # @!attribute version
+      #
+      #   @return [Integer]
+      required :version, Integer
+
+      # @!parse
+      #   # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      #   #   subscribed to by a customer. Plans define the billing behavior of the
+      #   #   subscription. You can see more about how to configure prices in the
+      #   #   [Price resource](/reference/price).
+      #   #
+      #   # @param id [String]
+      #   # @param adjustments [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>]
+      #   # @param base_plan [Orb::Models::Plan::BasePlan, nil]
+      #   # @param base_plan_id [String, nil]
+      #   # @param created_at [Time]
+      #   # @param currency [String]
+      #   # @param default_invoice_memo [String, nil]
+      #   # @param description [String]
+      #   # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+      #   # @param external_plan_id [String, nil]
+      #   # @param invoicing_currency [String]
+      #   # @param maximum [Orb::Models::Plan::Maximum, nil]
+      #   # @param maximum_amount [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param minimum [Orb::Models::Plan::Minimum, nil]
+      #   # @param minimum_amount [String, nil]
+      #   # @param name [String]
+      #   # @param net_terms [Integer, nil]
+      #   # @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
+      #   # @param prices [Array<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 product [Orb::Models::Plan::Product]
+      #   # @param status [Symbol, Orb::Models::Plan::Status]
+      #   # @param trial_config [Orb::Models::Plan::TrialConfig]
+      #   # @param version [Integer]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     adjustments:,
+      #     base_plan:,
+      #     base_plan_id:,
+      #     created_at:,
+      #     currency:,
+      #     default_invoice_memo:,
+      #     description:,
+      #     discount:,
+      #     external_plan_id:,
+      #     invoicing_currency:,
+      #     maximum:,
+      #     maximum_amount:,
+      #     metadata:,
+      #     minimum:,
+      #     minimum_amount:,
+      #     name:,
+      #     net_terms:,
+      #     plan_phases:,
+      #     prices:,
+      #     product:,
+      #     status:,
+      #     trial_config:,
+      #     version:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      module Adjustment
+        extend Orb::Union
+
+        discriminator :adjustment_type
+
+        variant :usage_discount, -> { Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment }
+
+        variant :amount_discount, -> { Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment }
+
+        variant :percentage_discount, -> { Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment }
+
+        variant :minimum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment }
+
+        variant :maximum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment }
+
+        class PlanPhaseUsageDiscountAdjustment < Orb::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute adjustment_type
+          #
+          #   @return [Symbol, :usage_discount]
+          required :adjustment_type, const: :usage_discount
+
+          # @!attribute applies_to_price_ids
+          #   The price IDs that this adjustment applies to.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::ArrayOf[String]
+
+          # @!attribute is_invoice_level
+          #   True for adjustments that apply to an entire invocice, false for adjustments
+          #     that apply to only one price.
+          #
+          #   @return [Boolean]
+          required :is_invoice_level, Orb::BooleanModel
+
+          # @!attribute plan_phase_order
+          #   The plan phase in which this adjustment is active.
+          #
+          #   @return [Integer, nil]
+          required :plan_phase_order, Integer, nil?: true
+
+          # @!attribute reason
+          #   The reason for the adjustment.
+          #
+          #   @return [String, nil]
+          required :reason, String, nil?: true
+
+          # @!attribute usage_discount
+          #   The number of usage units by which to discount the price this adjustment applies
+          #     to in a given billing period.
+          #
+          #   @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::BaseModel) -> void
+        end
+
+        class PlanPhaseAmountDiscountAdjustment < Orb::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute adjustment_type
+          #
+          #   @return [Symbol, :amount_discount]
+          required :adjustment_type, const: :amount_discount
+
+          # @!attribute amount_discount
+          #   The amount by which to discount the prices this adjustment applies to in a given
+          #     billing period.
+          #
+          #   @return [String]
+          required :amount_discount, String
+
+          # @!attribute applies_to_price_ids
+          #   The price IDs that this adjustment applies to.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::ArrayOf[String]
+
+          # @!attribute is_invoice_level
+          #   True for adjustments that apply to an entire invocice, false for adjustments
+          #     that apply to only one price.
+          #
+          #   @return [Boolean]
+          required :is_invoice_level, Orb::BooleanModel
+
+          # @!attribute plan_phase_order
+          #   The plan phase in which this adjustment is active.
+          #
+          #   @return [Integer, nil]
+          required :plan_phase_order, Integer, nil?: true
+
+          # @!attribute reason
+          #   The reason for the adjustment.
+          #
+          #   @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::BaseModel) -> void
+        end
+
+        class PlanPhasePercentageDiscountAdjustment < Orb::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute adjustment_type
+          #
+          #   @return [Symbol, :percentage_discount]
+          required :adjustment_type, const: :percentage_discount
+
+          # @!attribute applies_to_price_ids
+          #   The price IDs that this adjustment applies to.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::ArrayOf[String]
+
+          # @!attribute is_invoice_level
+          #   True for adjustments that apply to an entire invocice, false for adjustments
+          #     that apply to only one price.
+          #
+          #   @return [Boolean]
+          required :is_invoice_level, Orb::BooleanModel
+
+          # @!attribute percentage_discount
+          #   The percentage (as a value between 0 and 1) by which to discount the price
+          #     intervals this adjustment applies to in a given billing period.
+          #
+          #   @return [Float]
+          required :percentage_discount, Float
+
+          # @!attribute plan_phase_order
+          #   The plan phase in which this adjustment is active.
+          #
+          #   @return [Integer, nil]
+          required :plan_phase_order, Integer, nil?: true
+
+          # @!attribute reason
+          #   The reason for the adjustment.
+          #
+          #   @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::BaseModel) -> void
+        end
+
+        class PlanPhaseMinimumAdjustment < Orb::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute adjustment_type
+          #
+          #   @return [Symbol, :minimum]
+          required :adjustment_type, const: :minimum
+
+          # @!attribute applies_to_price_ids
+          #   The price IDs that this adjustment applies to.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::ArrayOf[String]
+
+          # @!attribute is_invoice_level
+          #   True for adjustments that apply to an entire invocice, false for adjustments
+          #     that apply to only one price.
+          #
+          #   @return [Boolean]
+          required :is_invoice_level, Orb::BooleanModel
+
+          # @!attribute item_id
+          #   The item ID that revenue from this minimum will be attributed to.
+          #
+          #   @return [String]
+          required :item_id, String
+
+          # @!attribute minimum_amount
+          #   The minimum amount to charge in a given billing period for the prices this
+          #     adjustment applies to.
+          #
+          #   @return [String]
+          required :minimum_amount, String
+
+          # @!attribute plan_phase_order
+          #   The plan phase in which this adjustment is active.
+          #
+          #   @return [Integer, nil]
+          required :plan_phase_order, Integer, nil?: true
+
+          # @!attribute reason
+          #   The reason for the adjustment.
+          #
+          #   @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::BaseModel) -> void
+        end
+
+        class PlanPhaseMaximumAdjustment < Orb::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute adjustment_type
+          #
+          #   @return [Symbol, :maximum]
+          required :adjustment_type, const: :maximum
+
+          # @!attribute applies_to_price_ids
+          #   The price IDs that this adjustment applies to.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::ArrayOf[String]
+
+          # @!attribute is_invoice_level
+          #   True for adjustments that apply to an entire invocice, false for adjustments
+          #     that apply to only one price.
+          #
+          #   @return [Boolean]
+          required :is_invoice_level, Orb::BooleanModel
+
+          # @!attribute maximum_amount
+          #   The maximum amount to charge in a given billing period for the prices this
+          #     adjustment applies to.
+          #
+          #   @return [String]
+          required :maximum_amount, String
+
+          # @!attribute plan_phase_order
+          #   The plan phase in which this adjustment is active.
+          #
+          #   @return [Integer, nil]
+          required :plan_phase_order, Integer, nil?: true
+
+          # @!attribute reason
+          #   The reason for the adjustment.
+          #
+          #   @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::BaseModel) -> void
+        end
+
+        # @!parse
+        #   # @return [Array(Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment)]
+        #   def self.variants; end
+      end
+
+      # @see Orb::Models::Plan#base_plan
+      class BasePlan < Orb::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        required :id, String, nil?: true
+
+        # @!attribute external_plan_id
+        #   An optional user-defined ID for this plan resource, used throughout the system
+        #     as an alias for this Plan. Use this field to identify a plan by an existing
+        #     identifier in your system.
+        #
+        #   @return [String, nil]
+        required :external_plan_id, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!parse
+        #   # @param id [String, nil]
+        #   # @param external_plan_id [String, nil]
+        #   # @param name [String, nil]
+        #   #
+        #   def initialize(id:, external_plan_id:, name:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+
+      # @see Orb::Models::Plan#maximum
+      class Maximum < Orb::BaseModel
+        # @!attribute applies_to_price_ids
+        #   List of price_ids that this maximum amount applies to. For plan/plan phase
+        #     maximums, this can be a subset of prices.
+        #
+        #   @return [Array<String>]
+        required :applies_to_price_ids, Orb::ArrayOf[String]
+
+        # @!attribute maximum_amount
+        #   Maximum amount applied
+        #
+        #   @return [String]
+        required :maximum_amount, String
+
+        # @!parse
+        #   # @param applies_to_price_ids [Array<String>]
+        #   # @param maximum_amount [String]
+        #   #
+        #   def initialize(applies_to_price_ids:, maximum_amount:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+
+      # @see Orb::Models::Plan#minimum
+      class Minimum < Orb::BaseModel
+        # @!attribute applies_to_price_ids
+        #   List of price_ids that this minimum amount applies to. For plan/plan phase
+        #     minimums, this can be a subset of prices.
+        #
+        #   @return [Array<String>]
+        required :applies_to_price_ids, Orb::ArrayOf[String]
+
+        # @!attribute minimum_amount
+        #   Minimum amount applied
+        #
+        #   @return [String]
+        required :minimum_amount, String
+
+        # @!parse
+        #   # @param applies_to_price_ids [Array<String>]
+        #   # @param minimum_amount [String]
+        #   #
+        #   def initialize(applies_to_price_ids:, minimum_amount:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+
+      class PlanPhase < Orb::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute discount
+        #
+        #   @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+        required :discount, union: -> { Orb::Models::Discount }, nil?: true
+
+        # @!attribute duration
+        #   How many terms of length `duration_unit` this phase is active for. If null, this
+        #     phase is evergreen and active indefinitely
+        #
+        #   @return [Integer, nil]
+        required :duration, Integer, nil?: true
+
+        # @!attribute duration_unit
+        #
+        #   @return [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
+        required :duration_unit, enum: -> { Orb::Models::Plan::PlanPhase::DurationUnit }, nil?: true
+
+        # @!attribute maximum
+        #
+        #   @return [Orb::Models::Plan::PlanPhase::Maximum, nil]
+        required :maximum, -> { Orb::Models::Plan::PlanPhase::Maximum }, nil?: true
+
+        # @!attribute maximum_amount
+        #
+        #   @return [String, nil]
+        required :maximum_amount, String, nil?: true
+
+        # @!attribute minimum
+        #
+        #   @return [Orb::Models::Plan::PlanPhase::Minimum, nil]
+        required :minimum, -> { Orb::Models::Plan::PlanPhase::Minimum }, nil?: true
+
+        # @!attribute minimum_amount
+        #
+        #   @return [String, nil]
+        required :minimum_amount, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute order
+        #   Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
+        #
+        #   @return [Integer]
+        required :order, Integer
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param description [String, nil]
+        #   # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+        #   # @param duration [Integer, nil]
+        #   # @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
+        #   # @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
+        #   # @param maximum_amount [String, nil]
+        #   # @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
+        #   # @param minimum_amount [String, nil]
+        #   # @param name [String]
+        #   # @param order [Integer]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     description:,
+        #     discount:,
+        #     duration:,
+        #     duration_unit:,
+        #     maximum:,
+        #     maximum_amount:,
+        #     minimum:,
+        #     minimum_amount:,
+        #     name:,
+        #     order:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        # @see Orb::Models::Plan::PlanPhase#duration_unit
+        module DurationUnit
+          extend Orb::Enum
+
+          DAILY = :daily
+          MONTHLY = :monthly
+          QUARTERLY = :quarterly
+          SEMI_ANNUAL = :semi_annual
+          ANNUAL = :annual
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        # @see Orb::Models::Plan::PlanPhase#maximum
+        class Maximum < Orb::BaseModel
+          # @!attribute applies_to_price_ids
+          #   List of price_ids that this maximum amount applies to. For plan/plan phase
+          #     maximums, this can be a subset of prices.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::ArrayOf[String]
+
+          # @!attribute maximum_amount
+          #   Maximum amount applied
+          #
+          #   @return [String]
+          required :maximum_amount, String
+
+          # @!parse
+          #   # @param applies_to_price_ids [Array<String>]
+          #   # @param maximum_amount [String]
+          #   #
+          #   def initialize(applies_to_price_ids:, maximum_amount:, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+
+        # @see Orb::Models::Plan::PlanPhase#minimum
+        class Minimum < Orb::BaseModel
+          # @!attribute applies_to_price_ids
+          #   List of price_ids that this minimum amount applies to. For plan/plan phase
+          #     minimums, this can be a subset of prices.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::ArrayOf[String]
+
+          # @!attribute minimum_amount
+          #   Minimum amount applied
+          #
+          #   @return [String]
+          required :minimum_amount, String
+
+          # @!parse
+          #   # @param applies_to_price_ids [Array<String>]
+          #   # @param minimum_amount [String]
+          #   #
+          #   def initialize(applies_to_price_ids:, minimum_amount:, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+      end
+
+      # @see Orb::Models::Plan#product
+      class Product < Orb::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param created_at [Time]
+        #   # @param name [String]
+        #   #
+        #   def initialize(id:, created_at:, name:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+
+      # @see Orb::Models::Plan#status
+      module Status
+        extend Orb::Enum
+
+        ACTIVE = :active
+        ARCHIVED = :archived
+        DRAFT = :draft
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # @see Orb::Models::Plan#trial_config
+      class TrialConfig < Orb::BaseModel
+        # @!attribute trial_period
+        #
+        #   @return [Integer, nil]
+        required :trial_period, Integer, nil?: true
+
+        # @!attribute trial_period_unit
+        #
+        #   @return [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
+        required :trial_period_unit, enum: -> { Orb::Models::Plan::TrialConfig::TrialPeriodUnit }
+
+        # @!parse
+        #   # @param trial_period [Integer, nil]
+        #   # @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
+        #   #
+        #   def initialize(trial_period:, trial_period_unit:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        # @see Orb::Models::Plan::TrialConfig#trial_period_unit
+        module TrialPeriodUnit
+          extend Orb::Enum
+
+          DAYS = :days
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end