Class: MetronomeSDK::Models::Subscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/subscription.rb,
sig/metronome_sdk/models/subscription.rbs

Defined Under Namespace

Modules: CollectionSchedule, QuantityManagementMode Classes: BillingCycleConfig, BillingPeriods, Proration, QuantitySchedule, SeatConfig, SubscriptionRate

Instance Attribute Summary collapse

Class Method 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(id:, name:) ⇒ Object

Parameters:

  • id (String)
  • name (String) 



# File 'lib/metronome_sdk/models/subscription.rb', line 95

Instance Attribute Details

#billing_cycle_config ⇒ MetronomeSDK::Models::Subscription::BillingCycleConfig?

Returns:



62
 
# File 'lib/metronome_sdk/models/subscription.rb', line 62

optional :billing_cycle_config, -> { MetronomeSDK::Subscription::BillingCycleConfig }

#billing_periods ⇒ MetronomeSDK::Models::Subscription::BillingPeriods

Previous, current, and next billing periods for the subscription.

Parameters:

  • value (MetronomeSDK::Subscription::BillingPeriods)

Returns:



10
 
# File 'lib/metronome_sdk/models/subscription.rb', line 10

required :billing_periods, -> { MetronomeSDK::Subscription::BillingPeriods }

#collection_schedule ⇒ Symbol, MetronomeSDK::Models::Subscription::CollectionSchedule

Parameters:

  • value (MetronomeSDK::Models::Subscription::collection_schedule)

Returns:



15
 
# File 'lib/metronome_sdk/models/subscription.rb', line 15

required :collection_schedule, enum: -> { MetronomeSDK::Subscription::CollectionSchedule }

#custom_fields ⇒ Hash{Symbol=>String}?

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


68
 
# File 'lib/metronome_sdk/models/subscription.rb', line 68

optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


73
 
# File 'lib/metronome_sdk/models/subscription.rb', line 73

optional :description, String

#ending_before ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


78
 
# File 'lib/metronome_sdk/models/subscription.rb', line 78

optional :ending_before, Time

#fiat_credit_type_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


83
 
# File 'lib/metronome_sdk/models/subscription.rb', line 83

optional :fiat_credit_type_id, String

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


57
 
# File 'lib/metronome_sdk/models/subscription.rb', line 57

optional :id, String

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


88
 
# File 'lib/metronome_sdk/models/subscription.rb', line 88

optional :name, String

#proration ⇒ MetronomeSDK::Models::Subscription::Proration

Parameters:

  • value (MetronomeSDK::Subscription::Proration)

Returns:



20
 
# File 'lib/metronome_sdk/models/subscription.rb', line 20

required :proration, -> { MetronomeSDK::Subscription::Proration }

#quantity_management_mode ⇒ Symbol, MetronomeSDK::Models::Subscription::QuantityManagementMode

Determines how the subscription's quantity is controlled. Defaults to QUANTITY_ONLY. QUANTITY_ONLY: The subscription quantity is specified directly on the subscription. initial_quantity must be provided with this option. Compatible with recurring commits/credits that use POOLED allocation. SEAT_BASED: Use when you want to pass specific seat identifiers (e.g. add user_123) to increment and decrement a subscription quantity, rather than directly providing the quantity. You must use a SEAT_BASED subscription to use a linked recurring credit with an allocation per seat. seat_config must be provided with this option.

Parameters:

  • value (MetronomeSDK::Models::Subscription::quantity_management_mode)

Returns:



34
 
# File 'lib/metronome_sdk/models/subscription.rb', line 34

required :quantity_management_mode, enum: -> { MetronomeSDK::Subscription::QuantityManagementMode }

#quantity_schedule ⇒ Array<MetronomeSDK::Models::Subscription::QuantitySchedule>

List of quantity schedule items for the subscription. Only includes the current quantity and future quantity changes.

Parameters:

  • value (::Array[MetronomeSDK::Subscription::QuantitySchedule])

Returns:



41
42
 
# File 'lib/metronome_sdk/models/subscription.rb', line 41

required :quantity_schedule,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Subscription::QuantitySchedule] }

#seat_config ⇒ MetronomeSDK::Models::Subscription::SeatConfig?

Returns:



93
 
# File 'lib/metronome_sdk/models/subscription.rb', line 93

optional :seat_config, -> { MetronomeSDK::Subscription::SeatConfig }

#starting_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


47
 
# File 'lib/metronome_sdk/models/subscription.rb', line 47

required :starting_at, Time

#subscription_rate ⇒ MetronomeSDK::Models::Subscription::SubscriptionRate

Parameters:

  • value (MetronomeSDK::Subscription::SubscriptionRate)

Returns:



52
 
# File 'lib/metronome_sdk/models/subscription.rb', line 52

required :subscription_rate, -> { MetronomeSDK::Subscription::SubscriptionRate }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/subscription.rb', line 212

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


91
 
# File 'sig/metronome_sdk/models/subscription.rbs', line 91

def to_hash: -> {