Class: MetronomeSDK::Models::ContractV2::Subscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/contract_v2.rb,
sig/metronome_sdk/models/contract_v2.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/contract_v2.rb', line 3758

Instance Attribute Details

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

Returns:



3725
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3725

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

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

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

Parameters:

  • value (MetronomeSDK::ContractV2::Subscription::BillingPeriods)

Returns:



3672
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3672

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

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

Parameters:

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

Returns:



3677
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3677

required :collection_schedule, enum: -> { MetronomeSDK::ContractV2::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) 


3731
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3731

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

#description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


3736
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3736

optional :description, String

#ending_before ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


3741
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3741

optional :ending_before, Time

#fiat_credit_type_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


3746
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3746

optional :fiat_credit_type_id, String

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


3720
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3720

optional :id, String

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


3751
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3751

optional :name, String

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

Parameters:

  • value (MetronomeSDK::ContractV2::Subscription::Proration)

Returns:



3682
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3682

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

#quantity_management_mode ⇒ Symbol, MetronomeSDK::Models::ContractV2::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::ContractV2::Subscription::quantity_management_mode)

Returns:



3696
3697
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3696

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

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

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

Parameters:

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

Returns:



3704
3705
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3704

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

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

Returns:



3756
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3756

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

#starting_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


3710
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3710

required :starting_at, Time

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

Parameters:

  • value (MetronomeSDK::ContractV2::Subscription::SubscriptionRate)

Returns:



3715
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3715

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/contract_v2.rb', line 3879

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


3674
 
# File 'sig/metronome_sdk/models/contract_v2.rbs', line 3674

def to_hash: -> {