Class: MetronomeSDK::Models::V1::ContractCreateParams::Subscription::Proration

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/contract_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: InvoiceBehavior

Instance Attribute 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(invoice_behavior: nil, is_prorated: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::ContractCreateParams::Subscription::Proration for more details.

Parameters:




# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3157

Instance Attribute Details

#invoice_behavior ⇒ Symbol, ...

Indicates how mid-period quantity adjustments are invoiced. BILL_IMMEDIATELY: Only available when collection schedule is ‘ADVANCE`. The quantity increase will be billed immediately on the scheduled date. BILL_ON_NEXT_COLLECTION_DATE: The quantity increase will be billed for in-arrears at the end of the period.

Returns:



3148
3149
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3148

optional :invoice_behavior,
enum: -> { MetronomeSDK::V1::ContractCreateParams::Subscription::Proration::InvoiceBehavior }

#is_prorated ⇒ Boolean?

Indicates if the partial period will be prorated or charged a full amount.

Returns:

  • (Boolean, nil) 


3155
 
# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 3155

optional :is_prorated, MetronomeSDK::Internal::Type::Boolean