Class: Orb::Models::Customers::Credits::TopUpInvoiceSettings

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/customers/credits/top_up_invoice_settings.rb

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(auto_collection: , net_terms: , memo: nil, require_successful_payment: nil) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Customers::Credits::TopUpInvoiceSettings for more details.

Parameters:

  • auto_collection (Boolean) (defaults to: ) —

    Whether the credits purchase invoice should auto collect with the customer’s sav

  • net_terms (Integer) (defaults to: ) —

    The net terms determines the difference between the invoice date and the issue d

  • memo (String, nil) (defaults to: nil) —

    An optional memo to display on the invoice.

  • require_successful_payment (Boolean) (defaults to: nil) —

    When true, credit blocks created by this top-up will require that the correspond




# File 'lib/orb/models/customers/credits/top_up_invoice_settings.rb', line 38

Instance Attribute Details

#auto_collection ⇒ Boolean

Whether the credits purchase invoice should auto collect with the customer’s saved payment method.

Returns:

  • (Boolean) 


13
 
# File 'lib/orb/models/customers/credits/top_up_invoice_settings.rb', line 13

required :auto_collection, Orb::Internal::Type::Boolean

#memo ⇒ String?

An optional memo to display on the invoice.

Returns:

  • (String, nil) 


27
 
# File 'lib/orb/models/customers/credits/top_up_invoice_settings.rb', line 27

optional :memo, String, nil?: true

#net_terms ⇒ Integer

The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0.

Returns:

  • (Integer) 


21
 
# File 'lib/orb/models/customers/credits/top_up_invoice_settings.rb', line 21

required :net_terms, Integer

#require_successful_payment ⇒ Boolean?

When true, credit blocks created by this top-up will require that the corresponding invoice is paid before they are drawn down from. If any topup block is pending payment, further automatic top-ups will be paused until the invoice is paid or voided.

Returns:

  • (Boolean, nil) 


36
 
# File 'lib/orb/models/customers/credits/top_up_invoice_settings.rb', line 36

optional :require_successful_payment, Orb::Internal::Type::Boolean