Class: MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

Modules: RateType Classes: AccessAmount, ProrationRounding

Instance Attribute Summary

• #access_amount ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::AccessAmount^?
• #ending_before ⇒ Time^?
• #proration_rounding ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::ProrationRounding^?

  If provided, updates the rounding config on the recurring credit.

• #rate_type ⇒ Symbol, ...

  If provided, updates the recurring credit to use the specified rate type when generating future credits.

• #recurring_credit_id ⇒ String

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(quantity: nil, unit_price: nil) ⇒ Object constructor
• #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(quantity: nil, unit_price: nil) ⇒ Object

Parameters:

• quantity (Float) (defaults to: nil)
• unit_price (Float) (defaults to: nil)

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

Instance Attribute Details

#access_amount ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::AccessAmount^?

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::AccessAmount, nil)

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

optional :access_amount, -> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCredit::AccessAmount }

#ending_before ⇒ Time^?

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

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

optional :ending_before, Time, nil?: true

#proration_rounding ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::ProrationRounding^?

If provided, updates the rounding config on the recurring credit. Set to null to clear rounding. Omit to leave unchanged.

Parameters:

• value (MetronomeSDK::V2::ContractEditParams::UpdateRecurringCredit::ProrationRounding, nil)

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::ProrationRounding, nil)

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

optional :proration_rounding,
-> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCredit::ProrationRounding },
nil?: true

#rate_type ⇒ Symbol, ...

If provided, updates the recurring credit to use the specified rate type when generating future credits.

Returns:

• (Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit::RateType, nil)

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

optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::UpdateRecurringCredit::RateType }

#recurring_credit_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :recurring_credit_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {