Class: Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::TrialOverrideConfiguration

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::TrialOverrideConfiguration

Defined in:

lib/stigg/models/v1/contract_create_params.rb,
sig/stigg/models/v1/contract_create_params.rbs

Overview

See Also:

• Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription#trial_override_configuration

Defined Under Namespace

Modules: TrialEndBehavior

Instance Attribute Summary

• #is_trial ⇒ Boolean

  Whether the subscription should start with a trial period.

• #trial_end_behavior ⇒ Symbol, ...

  Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION.

• #trial_end_date ⇒ Time^?

  Custom trial end date.

Instance Method Summary

• #initialize(is_trial:, trial_end_behavior: nil, trial_end_date: nil) ⇒ Object constructor

  Trial period override settings.

• #to_hash ⇒ {

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:

• is_trial (Boolean) —

  Whether the subscription should start with a trial period

• trial_end_behavior (Symbol, Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::TrialOverrideConfiguration::TrialEndBehavior) (defaults to: nil) —

  Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION

• trial_end_date (Time) (defaults to: nil) —

  Custom trial end date

# File 'lib/stigg/models/v1/contract_create_params.rb', line 2068

Instance Attribute Details

#is_trial ⇒ Boolean

Whether the subscription should start with a trial period

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/stigg/models/v1/contract_create_params.rb', line 2050

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:

• (Symbol, Stigg::Models::V1::ContractCreateParams::Subscription::NewSubscription::TrialOverrideConfiguration::TrialEndBehavior, nil)

# File 'lib/stigg/models/v1/contract_create_params.rb', line 2056

optional :trial_end_behavior,
enum: -> {
  Stigg::V1::ContractCreateParams::Subscription::NewSubscription::TrialOverrideConfiguration::TrialEndBehavior
},
api_name: :trialEndBehavior

#trial_end_date ⇒ Time^?

Custom trial end date

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/stigg/models/v1/contract_create_params.rb', line 2066

optional :trial_end_date, Time, api_name: :trialEndDate

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/stigg/models/v1/contract_create_params.rbs', line 2465

def to_hash: -> {