Class: Stigg::Models::V1::SubscriptionProvisionParams::TrialOverrideConfiguration

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/subscription_provision_params.rb

Defined Under Namespace

Modules: TrialEndBehavior

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(is_trial:, trial_end_behavior: nil, trial_end_date: nil) ⇒ Object

Trial period override settings

Parameters:




# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1891

Instance Attribute Details

#is_trial ⇒ Boolean

Whether the subscription should start with a trial period

Returns:

  • (Boolean) 


1873
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1873

required :is_trial, Stigg::Internal::Type::Boolean, api_name: :isTrial

#trial_end_behavior ⇒ Symbol, ...

Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION

Returns:



1879
1880
1881
1882
1883
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1879

optional :trial_end_behavior,
enum: -> {
  Stigg::V1::SubscriptionProvisionParams::TrialOverrideConfiguration::TrialEndBehavior
},
api_name: :trialEndBehavior

#trial_end_date ⇒ Time?

Custom trial end date

Returns:

  • (Time, nil) 


1889
 
# File 'lib/stigg/models/v1/subscription_provision_params.rb', line 1889

optional :trial_end_date, Time, api_name: :trialEndDate