Class: Orb::Models::SubscriptionUpdateTrialParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/subscription_update_trial_params.rb

Overview

See Also:

Defined Under Namespace

Modules: TrialEndDate

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(trial_end_date: , shift: nil, request_options: {}) ⇒ Object

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

Parameters:

  • trial_end_date (Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate) (defaults to: ) —

    The new date that the trial should end, or the literal string ‘immediate` to end

  • shift (Boolean) (defaults to: nil) —

    If true, shifts subsequent price and adjustment intervals (preserving their dura

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/orb/models/subscription_update_trial_params.rb', line 24

Instance Attribute Details

#shift ⇒ Boolean?

If true, shifts subsequent price and adjustment intervals (preserving their durations, but adjusting their absolute dates).

Returns:

  • (Boolean, nil) 


22
 
# File 'lib/orb/models/subscription_update_trial_params.rb', line 22

optional :shift, Orb::Internal::Type::Boolean

#trial_end_date ⇒ Time, ...

The new date that the trial should end, or the literal string ‘immediate` to end the trial immediately.

Returns:



15
 
# File 'lib/orb/models/subscription_update_trial_params.rb', line 15

required :trial_end_date, union: -> { Orb::SubscriptionUpdateTrialParams::TrialEndDate }