Class: Dodopayments::Models::Subscription::ScheduledChange

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/subscription.rb

Overview

See Also:

Defined Under Namespace

Classes: Addon

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Dodopayments::Internal::Type::BaseModel

Instance Attribute Details

#addons ⇒ Array<Dodopayments::Models::Subscription::ScheduledChange::Addon>

Addons included in the scheduled change

Returns:



287
288
 
# File 'lib/dodopayments/models/subscription.rb', line 287

required :addons,
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Subscription::ScheduledChange::Addon] }

#created_at ⇒ Time

When this scheduled change was created

Returns:

  • (Time) 


294
 
# File 'lib/dodopayments/models/subscription.rb', line 294

required :created_at, Time

#effective_at ⇒ Time

When the change will be applied

Returns:

  • (Time) 


300
 
# File 'lib/dodopayments/models/subscription.rb', line 300

required :effective_at, Time

#id ⇒ String

The scheduled plan change ID

Returns:

  • (String) 


281
 
# File 'lib/dodopayments/models/subscription.rb', line 281

required :id, String

#product_description ⇒ String?

Description of the product being changed to

Returns:

  • (String, nil) 


318
 
# File 'lib/dodopayments/models/subscription.rb', line 318

optional :product_description, String, nil?: true

#product_id ⇒ String

The product ID the subscription will change to

Returns:

  • (String) 


306
 
# File 'lib/dodopayments/models/subscription.rb', line 306

required :product_id, String

#product_name ⇒ String?

Name of the product being changed to

Returns:

  • (String, nil) 


324
 
# File 'lib/dodopayments/models/subscription.rb', line 324

optional :product_name, String, nil?: true

#quantity ⇒ Integer

Quantity for the new plan

Returns:

  • (Integer) 


312
 
# File 'lib/dodopayments/models/subscription.rb', line 312

required :quantity, Integer