Class: Stigg::Models::V1::Product::Data::ProductSettings

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::Product::Data::ProductSettings

Defined in:

lib/stigg/models/v1/product.rb

Overview

See Also:

• #product_settings

Defined Under Namespace

Modules: SubscriptionCancellationTime, SubscriptionEndSetup, SubscriptionStartSetup

Instance Attribute Summary

• #downgrade_plan_id ⇒ String^?

  ID of the plan to downgrade to at the end of the billing period.

• #prorate_at_end_of_billing_period ⇒ Boolean^?

  Indicates if the subscription should be prorated at the end of the billing period.

• #subscription_cancellation_time ⇒ Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionCancellationTime

  Time when the subscription will be cancelled.

• #subscription_end_setup ⇒ Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionEndSetup

  Setup for the end of the subscription.

• #subscription_start_plan_id ⇒ String^?

  ID of the plan to start the subscription with.

• #subscription_start_setup ⇒ Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionStartSetup

  Setup for the start of the subscription.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(subscription_cancellation_time:, subscription_end_setup:, subscription_start_setup:, downgrade_plan_id: nil, prorate_at_end_of_billing_period: nil, subscription_start_plan_id: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see ProductSettings for more details.

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(subscription_cancellation_time:, subscription_end_setup:, subscription_start_setup:, downgrade_plan_id: nil, prorate_at_end_of_billing_period: nil, subscription_start_plan_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Stigg::Models::V1::Product::Data::ProductSettings for more details.

Product behavior settings for subscription lifecycle management.

Parameters:

• subscription_cancellation_time (Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionCancellationTime) —

  Time when the subscription will be cancelled

• subscription_end_setup (Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionEndSetup) —

  Setup for the end of the subscription

• subscription_start_setup (Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionStartSetup) —

  Setup for the start of the subscription

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

  ID of the plan to downgrade to at the end of the billing period

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

  Indicates if the subscription should be prorated at the end of the billing perio

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

  ID of the plan to start the subscription with

# File 'lib/stigg/models/v1/product.rb', line 161

Instance Attribute Details

#downgrade_plan_id ⇒ String^?

ID of the plan to downgrade to at the end of the billing period

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/product.rb', line 143

optional :downgrade_plan_id, String, api_name: :downgradePlanId, nil?: true

#prorate_at_end_of_billing_period ⇒ Boolean^?

Indicates if the subscription should be prorated at the end of the billing period

Returns:

• (Boolean, nil)

# File 'lib/stigg/models/v1/product.rb', line 150

optional :prorate_at_end_of_billing_period,
Stigg::Internal::Type::Boolean,
api_name: :prorateAtEndOfBillingPeriod,
nil?: true

#subscription_cancellation_time ⇒ Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionCancellationTime

Time when the subscription will be cancelled

Returns:

• (Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionCancellationTime)

# File 'lib/stigg/models/v1/product.rb', line 119

required :subscription_cancellation_time,
enum: -> { Stigg::V1::Product::Data::ProductSettings::SubscriptionCancellationTime },
api_name: :subscriptionCancellationTime

#subscription_end_setup ⇒ Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionEndSetup

Setup for the end of the subscription

Returns:

• (Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionEndSetup)

# File 'lib/stigg/models/v1/product.rb', line 127

required :subscription_end_setup,
enum: -> { Stigg::V1::Product::Data::ProductSettings::SubscriptionEndSetup },
api_name: :subscriptionEndSetup

#subscription_start_plan_id ⇒ String^?

ID of the plan to start the subscription with

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/product.rb', line 159

optional :subscription_start_plan_id, String, api_name: :subscriptionStartPlanId, nil?: true

#subscription_start_setup ⇒ Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionStartSetup

Setup for the start of the subscription

Returns:

• (Symbol, Stigg::Models::V1::Product::Data::ProductSettings::SubscriptionStartSetup)

# File 'lib/stigg/models/v1/product.rb', line 135

required :subscription_start_setup,
enum: -> { Stigg::V1::Product::Data::ProductSettings::SubscriptionStartSetup },
api_name: :subscriptionStartSetup

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/stigg/models/v1/product.rb', line 189