Class: MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem

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

Defined Under Namespace

Classes: Tier, TierPeriod

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(starting_at: , ending_before: nil) ⇒ Object

when the current tier started and ends (for tiered charges only)

Parameters:

  • starting_at (Time) (defaults to: )
  • ending_before (Time) (defaults to: nil) 



# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 765

Instance Attribute Details

#charge_id ⇒ String?

Returns:

  • (String, nil) 


727
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 727

optional :charge_id, String

#credit_grant_id ⇒ String?

Returns:

  • (String, nil) 


732
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 732

optional :credit_grant_id, String

#custom_fields ⇒ Hash{Symbol=>String}

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

Returns:

  • (Hash{Symbol=>String}) 


707
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 707

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

#end_date ⇒ Time?

The end date for the charge (for seats charges only).

Returns:

  • (Time, nil) 


738
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 738

optional :end_date, Time

#name ⇒ String

Returns:

  • (String) 


712
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 712

required :name, String

#price ⇒ Float?

the unit price for this charge, present only if the charge is not tiered and the quantity is nonzero

Returns:

  • (Float, nil) 


745
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 745

optional :price, Float

#quantity ⇒ Float

Returns:

  • (Float) 


717
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 717

required :quantity, Float

#start_date ⇒ Time?

The start date for the charge (for seats charges only).

Returns:

  • (Time, nil) 


751
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 751

optional :start_date, Time

#subtotal ⇒ Float

Returns:

  • (Float) 


722
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 722

required :subtotal, Float

#tier_period ⇒ MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem::TierPeriod?

when the current tier started and ends (for tiered charges only)

Returns:



757
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 757

optional :tier_period, -> { MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem::TierPeriod }

#tiers ⇒ Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem::SubLineItem::Tier>?

Returns:



762
763
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 762

optional :tiers,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem::SubLineItem::Tier] }