Class: Dodopayments::Models::CreditEntitlement

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/credit_entitlement.rb

Overview

See Also:

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(id:, business_id:, created_at:, name:, overage_behavior:, overage_enabled:, precision:, rollover_enabled:, unit:, updated_at:, currency: nil, description: nil, expires_after_days: nil, max_rollover_count: nil, overage_limit: nil, price_per_unit: nil, rollover_percentage: nil, rollover_timeframe_count: nil, rollover_timeframe_interval: nil) ⇒ Object

Parameters:

  • id (String)
  • business_id (String)
  • created_at (Time)
  • name (String)
  • overage_behavior (Symbol, Dodopayments::Models::CbbOverageBehavior) —

    Controls how overage is handled at billing cycle end.

  • overage_enabled (Boolean)
  • precision (Integer)
  • rollover_enabled (Boolean)
  • unit (String)
  • updated_at (Time)
  • currency (Symbol, Dodopayments::Models::Currency, nil) (defaults to: nil)
  • description (String, nil) (defaults to: nil)
  • expires_after_days (Integer, nil) (defaults to: nil)
  • max_rollover_count (Integer, nil) (defaults to: nil)
  • overage_limit (Integer, nil) (defaults to: nil)
  • price_per_unit (String, nil) (defaults to: nil) —

    Price per credit unit

  • rollover_percentage (Integer, nil) (defaults to: nil)
  • rollover_timeframe_count (Integer, nil) (defaults to: nil)
  • rollover_timeframe_interval (Symbol, Dodopayments::Models::TimeInterval, nil) (defaults to: nil) 



# File 'lib/dodopayments/models/credit_entitlement.rb', line 104

Instance Attribute Details

#business_id ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 15

required :business_id, String

#created_at ⇒ Time

Returns:

  • (Time) 


20
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 20

required :created_at, Time

#currency ⇒ Symbol, ...

Returns:



61
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 61

optional :currency, enum: -> { Dodopayments::Currency }, nil?: true

#description ⇒ String?

Returns:

  • (String, nil) 


66
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 66

optional :description, String, nil?: true

#expires_after_days ⇒ Integer?

Returns:

  • (Integer, nil) 


71
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 71

optional :expires_after_days, Integer, nil?: true

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 10

required :id, String

#max_rollover_count ⇒ Integer?

Returns:

  • (Integer, nil) 


76
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 76

optional :max_rollover_count, Integer, nil?: true

#name ⇒ String

Returns:

  • (String) 


25
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 25

required :name, String

#overage_behavior ⇒ Symbol, Dodopayments::Models::CbbOverageBehavior

Controls how overage is handled at billing cycle end.

Returns:



31
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 31

required :overage_behavior, enum: -> { Dodopayments::CbbOverageBehavior }

#overage_enabled ⇒ Boolean

Returns:

  • (Boolean) 


36
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 36

required :overage_enabled, Dodopayments::Internal::Type::Boolean

#overage_limit ⇒ Integer?

Returns:

  • (Integer, nil) 


81
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 81

optional :overage_limit, Integer, nil?: true

#precision ⇒ Integer

Returns:

  • (Integer) 


41
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 41

required :precision, Integer

#price_per_unit ⇒ String?

Price per credit unit

Returns:

  • (String, nil) 


87
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 87

optional :price_per_unit, String, nil?: true

#rollover_enabled ⇒ Boolean

Returns:

  • (Boolean) 


46
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 46

required :rollover_enabled, Dodopayments::Internal::Type::Boolean

#rollover_percentage ⇒ Integer?

Returns:

  • (Integer, nil) 


92
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 92

optional :rollover_percentage, Integer, nil?: true

#rollover_timeframe_count ⇒ Integer?

Returns:

  • (Integer, nil) 


97
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 97

optional :rollover_timeframe_count, Integer, nil?: true

#rollover_timeframe_interval ⇒ Symbol, ...

Returns:



102
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 102

optional :rollover_timeframe_interval, enum: -> { Dodopayments::TimeInterval }, nil?: true

#unit ⇒ String

Returns:

  • (String) 


51
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 51

required :unit, String

#updated_at ⇒ Time

Returns:

  • (Time) 


56
 
# File 'lib/dodopayments/models/credit_entitlement.rb', line 56

required :updated_at, Time