Module: Orb::Models::Plan::Adjustment

Extended by:

Internal::Type::Union

Defined in:

lib/orb/models/plan.rb

Instance Method Summary

• #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: ) ⇒ Object

  Some parameter documentations has been truncated, see Orb::Models::Plan for more details.

Methods included from Internal::Type::Union

==, ===, coerce, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#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: ) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Plan for more details.

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).

Parameters:

• id (String) (defaults to: )
• adjustments (Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>) (defaults to: ) —

  Adjustments for this plan. If the plan has phases, this includes adjustments acr

• base_plan (Orb::Models::Plan::BasePlan, nil) (defaults to: )
• base_plan_id (String, nil) (defaults to: ) —

  The parent plan id if the given plan was created by overriding one or more of th

• created_at (Time) (defaults to: )
• currency (String) (defaults to: ) —

  An ISO 4217 currency string or custom pricing unit (‘credits`) for this plan’s p

• default_invoice_memo (String, nil) (defaults to: ) —

  The default memo text on the invoices corresponding to subscriptions on this pla

• description (String) (defaults to: )
• discount (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil) (defaults to: )
• external_plan_id (String, nil) (defaults to: ) —

  An optional user-defined ID for this plan resource, used throughout the system a

• invoicing_currency (String) (defaults to: ) —

  An ISO 4217 currency string for which this plan is billed in. Matches ‘currency`

• maximum (Orb::Models::Maximum, nil) (defaults to: )
• maximum_amount (String, nil) (defaults to: )
• metadata (Hash{Symbol=>String}) (defaults to: ) —

  User specified key-value pairs for the resource. If not present, this defaults t

• minimum (Orb::Models::Minimum, nil) (defaults to: )
• minimum_amount (String, nil) (defaults to: )
• name (String) (defaults to: )
• net_terms (Integer, nil) (defaults to: ) —

  Determines the difference between the invoice issue date and the due date. A val

• plan_phases (Array<Orb::Models::Plan::PlanPhase>, nil) (defaults to: )
• prices (Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::GroupedWithMinMaxThresholds>) (defaults to: ) —

  Prices for this plan. If the plan has phases, this includes prices across all ph

• product (Orb::Models::Plan::Product) (defaults to: )
• status (Symbol, Orb::Models::Plan::Status) (defaults to: )
• trial_config (Orb::Models::Plan::TrialConfig) (defaults to: )
• version (Integer) (defaults to: )

# File 'lib/orb/models/plan.rb', line 215

module Adjustment
  extend Orb::Internal::Type::Union

  discriminator :adjustment_type

  variant :usage_discount, -> { Orb::PlanPhaseUsageDiscountAdjustment }

  variant :amount_discount, -> { Orb::PlanPhaseAmountDiscountAdjustment }

  variant :percentage_discount, -> { Orb::PlanPhasePercentageDiscountAdjustment }

  variant :minimum, -> { Orb::PlanPhaseMinimumAdjustment }

  variant :maximum, -> { Orb::PlanPhaseMaximumAdjustment }

  # @!method self.variants
  #   @return [Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)]
end