Class: Dodopayments::Models::CreditEntitlementUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/dodopayments/models/credit_entitlement_update_params.rb

Overview

See Also:

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

Parameters:

  • id (String)
  • currency (Symbol, Dodopayments::Models::Currency, nil) (defaults to: nil) —

    Currency for pricing

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

    Optional description of the credit entitlement

  • expires_after_days (Integer, nil) (defaults to: nil) —

    Number of days after which credits expire

  • max_rollover_count (Integer, nil) (defaults to: nil) —

    Maximum number of times credits can be rolled over

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

    Name of the credit entitlement

  • overage_behavior (Symbol, Dodopayments::Models::CbbOverageBehavior, nil) (defaults to: nil) —

    Controls how overage is handled at billing cycle end.

  • overage_enabled (Boolean, nil) (defaults to: nil) —

    Whether overage charges are enabled when credits run out

  • overage_limit (Integer, nil) (defaults to: nil) —

    Maximum overage units allowed

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

    Price per credit unit

  • rollover_enabled (Boolean, nil) (defaults to: nil) —

    Whether rollover is enabled for unused credits

  • rollover_percentage (Integer, nil) (defaults to: nil) —

    Percentage of unused credits that can rollover (0-100)

  • rollover_timeframe_count (Integer, nil) (defaults to: nil) —

    Count of timeframe periods for rollover limit

  • rollover_timeframe_interval (Symbol, Dodopayments::Models::TimeInterval, nil) (defaults to: nil) —

    Interval type for rollover timeframe

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

    Unit of measurement for the credit (e.g., “API Calls”, “Tokens”, “Credits”)

  • request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 99

Instance Attribute Details

#currency ⇒ Symbol, ...

Currency for pricing

Returns:



19
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 19

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

#description ⇒ String?

Optional description of the credit entitlement

Returns:

  • (String, nil) 


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

optional :description, String, nil?: true

#expires_after_days ⇒ Integer?

Number of days after which credits expire

Returns:

  • (Integer, nil) 


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

optional :expires_after_days, Integer, nil?: true

#id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 13

required :id, String

#max_rollover_count ⇒ Integer?

Maximum number of times credits can be rolled over

Returns:

  • (Integer, nil) 


37
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 37

optional :max_rollover_count, Integer, nil?: true

#name ⇒ String?

Name of the credit entitlement

Returns:

  • (String, nil) 


43
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 43

optional :name, String, nil?: true

#overage_behavior ⇒ Symbol, ...

Controls how overage is handled at billing cycle end.

Returns:



49
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 49

optional :overage_behavior, enum: -> { Dodopayments::CbbOverageBehavior }, nil?: true

#overage_enabled ⇒ Boolean?

Whether overage charges are enabled when credits run out

Returns:

  • (Boolean, nil) 


55
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 55

optional :overage_enabled, Dodopayments::Internal::Type::Boolean, nil?: true

#overage_limit ⇒ Integer?

Maximum overage units allowed

Returns:

  • (Integer, nil) 


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

optional :overage_limit, Integer, nil?: true

#price_per_unit ⇒ String?

Price per credit unit

Returns:

  • (String, nil) 


67
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 67

optional :price_per_unit, String, nil?: true

#rollover_enabled ⇒ Boolean?

Whether rollover is enabled for unused credits

Returns:

  • (Boolean, nil) 


73
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 73

optional :rollover_enabled, Dodopayments::Internal::Type::Boolean, nil?: true

#rollover_percentage ⇒ Integer?

Percentage of unused credits that can rollover (0-100)

Returns:

  • (Integer, nil) 


79
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 79

optional :rollover_percentage, Integer, nil?: true

#rollover_timeframe_count ⇒ Integer?

Count of timeframe periods for rollover limit

Returns:

  • (Integer, nil) 


85
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 85

optional :rollover_timeframe_count, Integer, nil?: true

#rollover_timeframe_interval ⇒ Symbol, ...

Interval type for rollover timeframe

Returns:



91
 
# File 'lib/dodopayments/models/credit_entitlement_update_params.rb', line 91

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

#unit ⇒ String?

Unit of measurement for the credit (e.g., “API Calls”, “Tokens”, “Credits”)

Returns:

  • (String, nil) 


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

optional :unit, String, nil?: true