Class: Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb

Overview

See Also:

Defined Under Namespace

Modules: ExpiresAfterUnit Classes: InvoiceSettings

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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 InvoiceSettings for more details.

Settings for invoices generated by triggered top-ups.

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_create_by_external_id_params.rb', line 120

Instance Attribute Details

#active_from ⇒ Time?

The date from which the top-up is active. If unspecified, the top-up is active immediately. This should not be more than 10 days in the past.

Returns:

  • (Time, nil) 


49
 
# File 'lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb', line 49

optional :active_from, Time, nil?: true

#amount ⇒ String

The amount to increment when the threshold is reached.

Returns:

  • (String) 


16
 
# File 'lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb', line 16

required :amount, String

#currency ⇒ String

The currency or custom pricing unit to use for this top-up. If this is a real-world currency, it must match the customer’s invoicing currency.

Returns:

  • (String) 


23
 
# File 'lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb', line 23

required :currency, String

#expires_after ⇒ Integer?

The number of days or months after which the top-up expires. If unspecified, it does not expire.

Returns:

  • (Integer, nil) 


56
 
# File 'lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb', line 56

optional :expires_after, Integer, nil?: true

#expires_after_unit ⇒ Symbol, ...

The unit of expires_after.

Returns:



62
63
64
 
# File 'lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb', line 62

optional :expires_after_unit,
enum: -> { Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit },
nil?: true

#invoice_settings ⇒ Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings

Settings for invoices generated by triggered top-ups.

Returns:



29
 
# File 'lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb', line 29

required :invoice_settings, -> { Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings }

#per_unit_cost_basis ⇒ String

How much, in the customer’s currency, to charge for each unit.

Returns:

  • (String) 


35
 
# File 'lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb', line 35

required :per_unit_cost_basis, String

#threshold ⇒ String

The threshold at which to trigger the top-up. If the balance is at or below this threshold, the top-up will be triggered.

Returns:

  • (String) 


42
 
# File 'lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb', line 42

required :threshold, String