Class: Dodopayments::Models::CreditEntitlementCreateParams

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

Overview

See Also:

  • Dodopayments::Resources::CreditEntitlements#create

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Dodopayments

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

Some parameter documentations has been truncated, see Dodopayments::Models::CreditEntitlementCreateParams for more details.

Parameters:

  • name (String) —

    Name of the credit entitlement

  • overage_enabled (Boolean) —

    Whether overage charges are enabled when credits run out

  • precision (Integer) —

    Precision for credit amounts (0-10 decimal places)

  • rollover_enabled (Boolean) —

    Whether rollover is enabled for unused credits

  • unit (String) —

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

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

    Currency for pricing (required if price_per_unit is set)

  • 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 (optional)

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

    Maximum number of times credits can be rolled over

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

    Controls how overage is handled at billing cycle end.

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

    Maximum overage units allowed (optional)

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

    Price per credit unit

  • 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

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



# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 101

Instance Attribute Details

#currency ⇒ Symbol, ...

Currency for pricing (required if price_per_unit is set)

Parameters:

  • value (Dodopayments::Models::currency, nil)

Returns:



44
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 44

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

#description ⇒ String?

Optional description of the credit entitlement

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


50
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 50

optional :description, String, nil?: true

#expires_after_days ⇒ Integer?

Number of days after which credits expire (optional)

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

optional :expires_after_days, Integer, nil?: true

#max_rollover_count ⇒ Integer?

Maximum number of times credits can be rolled over

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


62
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 62

optional :max_rollover_count, Integer, nil?: true

#name ⇒ String

Name of the credit entitlement

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 14

required :name, String

#overage_behavior ⇒ Symbol, ...

Controls how overage is handled at billing cycle end. Defaults to forgive_at_reset if not specified.

Parameters:

  • value (Dodopayments::Models::cbb_overage_behavior, nil)

Returns:



69
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 69

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

#overage_enabled ⇒ Boolean

Whether overage charges are enabled when credits run out

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

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

#overage_limit ⇒ Integer?

Maximum overage units allowed (optional)

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


75
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 75

optional :overage_limit, Integer, nil?: true

#precision ⇒ Integer

Precision for credit amounts (0-10 decimal places)

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


26
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 26

required :precision, Integer

#price_per_unit ⇒ String?

Price per credit unit

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :price_per_unit, String, nil?: true

#rollover_enabled ⇒ Boolean

Whether rollover is enabled for unused credits

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


32
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 32

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

#rollover_percentage ⇒ Integer?

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

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


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

optional :rollover_percentage, Integer, nil?: true

#rollover_timeframe_count ⇒ Integer?

Count of timeframe periods for rollover limit

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


93
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 93

optional :rollover_timeframe_count, Integer, nil?: true

#rollover_timeframe_interval ⇒ Symbol, ...

Interval type for rollover timeframe

Parameters:

  • value (Dodopayments::Models::time_interval, nil)

Returns:



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

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

#unit ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


38
 
# File 'lib/dodopayments/models/credit_entitlement_create_params.rb', line 38

required :unit, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


76
 
# File 'sig/dodopayments/models/credit_entitlement_create_params.rbs', line 76

def to_hash: -> {