Class: Orb::Models::PlanCreateParams::PlanPhase

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/plan_create_params.rb

Defined Under Namespace

Modules: DurationUnit

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(order: , align_billing_with_phase_start_date: nil, duration: nil, duration_unit: nil) ⇒ Object

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

Parameters:

  • order (Integer) (defaults to: ) —

    Determines the ordering of the phase in a plan’s lifecycle. 1 = first phase.

  • align_billing_with_phase_start_date (Boolean, nil) (defaults to: nil) —

    Align billing cycle day with phase start date.

  • duration (Integer, nil) (defaults to: nil) —

    How many terms of length ‘duration_unit` this phase is active for. If null, this

  • duration_unit (Symbol, Orb::Models::PlanCreateParams::PlanPhase::DurationUnit, nil) (defaults to: nil) 



# File 'lib/orb/models/plan_create_params.rb', line 268

Instance Attribute Details

#align_billing_with_phase_start_date ⇒ Boolean?

Align billing cycle day with phase start date.

Returns:

  • (Boolean, nil) 


254
 
# File 'lib/orb/models/plan_create_params.rb', line 254

optional :align_billing_with_phase_start_date, Orb::Internal::Type::Boolean, nil?: true

#duration ⇒ Integer?

How many terms of length ‘duration_unit` this phase is active for. If null, this phase is evergreen and active indefinitely

Returns:

  • (Integer, nil) 


261
 
# File 'lib/orb/models/plan_create_params.rb', line 261

optional :duration, Integer, nil?: true

#duration_unit ⇒ Symbol, ...

Returns:



266
 
# File 'lib/orb/models/plan_create_params.rb', line 266

optional :duration_unit, enum: -> { Orb::PlanCreateParams::PlanPhase::DurationUnit }, nil?: true

#order ⇒ Integer

Determines the ordering of the phase in a plan’s lifecycle. 1 = first phase.

Returns:

  • (Integer) 


248
 
# File 'lib/orb/models/plan_create_params.rb', line 248

required :order, Integer