Class: MetronomeSDK::Models::V2::ContractEditParams::AddSubscription

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V2::ContractEditParams::AddSubscription

Defined in:

lib/metronome_sdk/models/v2/contract_edit_params.rb,
sig/metronome_sdk/models/v2/contract_edit_params.rbs

Defined Under Namespace

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

Instance Attribute Summary

• #billing_cycle_config ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::BillingCycleConfig^?
• #collection_schedule ⇒ Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::CollectionSchedule
• #custom_fields ⇒ Hash{Symbol=>String}^?

  Custom fields to be added eg.

• #description ⇒ String^?
• #ending_before ⇒ Time^?

  Exclusive end time for the subscription.

• #initial_quantity ⇒ Float^?

  The initial quantity for the subscription.

• #name ⇒ String^?
• #proration ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration
• #quantity_management_mode ⇒ Symbol, ...

  Determines how the subscription's quantity is controlled.

• #seat_config ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::SeatConfig^?
• #starting_at ⇒ Time^?

  Inclusive start time for the subscription.

• #subscription_rate ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::SubscriptionRate
• #temporary_id ⇒ String^?

  A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(collection_schedule:, proration:, subscription_rate:, billing_cycle_config: nil, custom_fields: nil, description: nil, ending_before: nil, initial_quantity: nil, name: nil, quantity_management_mode: nil, seat_config: nil, starting_at: nil, temporary_id: nil) ⇒ Object constructor

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

• #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(collection_schedule:, proration:, subscription_rate:, billing_cycle_config: nil, custom_fields: nil, description: nil, ending_before: nil, initial_quantity: nil, name: nil, quantity_management_mode: nil, seat_config: nil, starting_at: nil, temporary_id: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V2::ContractEditParams::AddSubscription for more details.

Parameters:

• collection_schedule (Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::CollectionSchedule)
• proration (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration)
• subscription_rate (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::SubscriptionRate)
• billing_cycle_config (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::BillingCycleConfig) (defaults to: nil)
• custom_fields (Hash{Symbol=>String}) (defaults to: nil) —

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

• description (String) (defaults to: nil)
• ending_before (Time) (defaults to: nil) —

  Exclusive end time for the subscription. If not provided, subscription inherits

• initial_quantity (Float) (defaults to: nil) —

  The initial quantity for the subscription. It must be non-negative value. Requir

• name (String) (defaults to: nil)
• quantity_management_mode (Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::QuantityManagementMode) (defaults to: nil) —

  Determines how the subscription's quantity is controlled. Defaults to QUANTITY_O

• seat_config (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::SeatConfig) (defaults to: nil)
• starting_at (Time) (defaults to: nil) —

  Inclusive start time for the subscription. If not provided, defaults to contract

• temporary_id (String) (defaults to: nil) —

  A temporary ID used to reference the subscription in recurring commit/credit sub

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3436

Instance Attribute Details

#billing_cycle_config ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::BillingCycleConfig^?

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::BillingCycleConfig, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3369

optional :billing_cycle_config,
-> { MetronomeSDK::V2::ContractEditParams::AddSubscription::BillingCycleConfig }

#collection_schedule ⇒ Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::CollectionSchedule

Parameters:

• value (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::collection_schedule)

Returns:

• (Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::CollectionSchedule)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3352

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

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3376

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

#description ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3381

optional :description, String

#ending_before ⇒ Time^?

Exclusive end time for the subscription. If not provided, subscription inherits contract end date.

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3388

optional :ending_before, Time

#initial_quantity ⇒ Float^?

The initial quantity for the subscription. It must be non-negative value. Required if quantity_management_mode is QUANTITY_ONLY.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3395

optional :initial_quantity, Float

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3400

optional :name, String

#proration ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration

Parameters:

• value (MetronomeSDK::V2::ContractEditParams::AddSubscription::Proration)

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3358

required :proration, -> { MetronomeSDK::V2::ContractEditParams::AddSubscription::Proration }

#quantity_management_mode ⇒ Symbol, ...

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.

Returns:

• (Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::QuantityManagementMode, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3414

optional :quantity_management_mode,
enum: -> { MetronomeSDK::V2::ContractEditParams::AddSubscription::QuantityManagementMode }

#seat_config ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::SeatConfig^?

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::SeatConfig, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3420

optional :seat_config, -> { MetronomeSDK::V2::ContractEditParams::AddSubscription::SeatConfig }

#starting_at ⇒ Time^?

Inclusive start time for the subscription. If not provided, defaults to contract start date

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3427

optional :starting_at, Time

#subscription_rate ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::SubscriptionRate

Parameters:

• value (MetronomeSDK::V2::ContractEditParams::AddSubscription::SubscriptionRate)

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::SubscriptionRate)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3363

required :subscription_rate,
-> { MetronomeSDK::V2::ContractEditParams::AddSubscription::SubscriptionRate }

#temporary_id ⇒ String^?

A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3434

optional :temporary_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 3474

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/v2/contract_edit_params.rbs', line 3154

def to_hash: -> {