Class: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule

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

Defined Under Namespace

Classes: RecurringSchedule, ScheduleItem

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(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule for more details.

Required for “POSTPAID” commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match accesss_schedule amount. Optional for “PREPAID” commits: if not provided, this will be a “complimentary” commit with no invoice.

Parameters:




# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 266

Instance Attribute Details

#credit_type_id ⇒ String?

Defaults to USD (cents) if not passed.

Returns:

  • (String, nil) 


241
 
# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 241

optional :credit_type_id, String

#do_not_invoice ⇒ Boolean?

This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.

Returns:

  • (Boolean, nil) 


248
 
# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 248

optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean

#recurring_schedule ⇒ MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule?

Enter the unit price and quantity for the charge or instead only send the amount. If amount is sent, the unit price is assumed to be the amount and quantity is inferred to be 1.

Returns:



256
257
 
# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 256

optional :recurring_schedule,
-> { MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule }

#schedule_items ⇒ Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem>?

Either provide amount or provide both unit_price and quantity.

Returns:



263
264
 
# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 263

optional :schedule_items,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 378