Class: Dodopayments::Models::CreditEntitlementMappingResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/credit_entitlement_mapping_response.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(id:, credit_entitlement_id:, credit_entitlement_name:, credit_entitlement_unit:, credits_amount:, overage_behavior:, overage_enabled:, proration_behavior:, rollover_enabled:, trial_credits_expire_after_trial:, currency: nil, expires_after_days: nil, low_balance_threshold_percent: nil, max_rollover_count: nil, overage_limit: nil, price_per_unit: nil, rollover_percentage: nil, rollover_timeframe_count: nil, rollover_timeframe_interval: nil, trial_credits: nil) ⇒ Object

Response struct for credit entitlement mapping

Parameters:

  • id (String) —

    Unique ID of this mapping

  • credit_entitlement_id (String) —

    ID of the credit entitlement

  • credit_entitlement_name (String) —

    Name of the credit entitlement

  • credit_entitlement_unit (String) —

    Unit label for the credit entitlement

  • credits_amount (String) —

    Number of credits granted

  • overage_behavior (Symbol, Dodopayments::Models::CbbOverageBehavior) —

    Controls how overage is handled at billing cycle end.

  • overage_enabled (Boolean) —

    Whether overage is enabled

  • proration_behavior (Symbol, Dodopayments::Models::CbbProrationBehavior) —

    Proration behavior for credit grants during plan changes

  • rollover_enabled (Boolean) —

    Whether rollover is enabled

  • trial_credits_expire_after_trial (Boolean) —

    Whether trial credits expire after trial

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

    Currency

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

    Days until credits expire

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

    Low balance threshold percentage

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

    Maximum rollover cycles

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

    Overage limit

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

    Price per unit

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

    Rollover percentage

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

    Rollover timeframe count

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

    Rollover timeframe interval

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

    Trial credits




# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 126

Instance Attribute Details

#credit_entitlement_id ⇒ String

ID of the credit entitlement

Returns:

  • (String) 


16
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 16

required :credit_entitlement_id, String

#credit_entitlement_name ⇒ String

Name of the credit entitlement

Returns:

  • (String) 


22
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 22

required :credit_entitlement_name, String

#credit_entitlement_unit ⇒ String

Unit label for the credit entitlement

Returns:

  • (String) 


28
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 28

required :credit_entitlement_unit, String

#credits_amount ⇒ String

Number of credits granted

Returns:

  • (String) 


34
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 34

required :credits_amount, String

#currency ⇒ Symbol, ...

Currency

Returns:



70
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 70

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

#expires_after_days ⇒ Integer?

Days until credits expire

Returns:

  • (Integer, nil) 


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

optional :expires_after_days, Integer, nil?: true

#id ⇒ String

Unique ID of this mapping

Returns:

  • (String) 


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

required :id, String

#low_balance_threshold_percent ⇒ Integer?

Low balance threshold percentage

Returns:

  • (Integer, nil) 


82
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 82

optional :low_balance_threshold_percent, Integer, nil?: true

#max_rollover_count ⇒ Integer?

Maximum rollover cycles

Returns:

  • (Integer, nil) 


88
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 88

optional :max_rollover_count, Integer, nil?: true

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

Controls how overage is handled at billing cycle end.

Returns:



40
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 40

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

#overage_enabled ⇒ Boolean

Whether overage is enabled

Returns:

  • (Boolean) 


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

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

#overage_limit ⇒ String?

Overage limit

Returns:

  • (String, nil) 


94
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 94

optional :overage_limit, String, nil?: true

#price_per_unit ⇒ String?

Price per unit

Returns:

  • (String, nil) 


100
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 100

optional :price_per_unit, String, nil?: true

#proration_behavior ⇒ Symbol, Dodopayments::Models::CbbProrationBehavior

Proration behavior for credit grants during plan changes

Returns:



52
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 52

required :proration_behavior, enum: -> { Dodopayments::CbbProrationBehavior }

#rollover_enabled ⇒ Boolean

Whether rollover is enabled

Returns:

  • (Boolean) 


58
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 58

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

#rollover_percentage ⇒ Integer?

Rollover percentage

Returns:

  • (Integer, nil) 


106
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 106

optional :rollover_percentage, Integer, nil?: true

#rollover_timeframe_count ⇒ Integer?

Rollover timeframe count

Returns:

  • (Integer, nil) 


112
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 112

optional :rollover_timeframe_count, Integer, nil?: true

#rollover_timeframe_interval ⇒ Symbol, ...

Rollover timeframe interval

Returns:



118
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 118

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

#trial_credits ⇒ String?

Trial credits

Returns:

  • (String, nil) 


124
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 124

optional :trial_credits, String, nil?: true

#trial_credits_expire_after_trial ⇒ Boolean

Whether trial credits expire after trial

Returns:

  • (Boolean) 


64
 
# File 'lib/dodopayments/models/credit_entitlement_mapping_response.rb', line 64

required :trial_credits_expire_after_trial, Dodopayments::Internal::Type::Boolean