Class: Dodopayments::Models::CreditEntitlementCartResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/credit_entitlement_cart_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(credit_entitlement_id:, credit_entitlement_name:, credits_amount:, overage_balance:, overage_behavior:, overage_enabled:, product_id:, remaining_balance:, rollover_enabled:, unit:, expires_after_days: nil, low_balance_threshold_percent: nil, max_rollover_count: nil, overage_limit: nil, rollover_percentage: nil, rollover_timeframe_count: nil, rollover_timeframe_interval: nil) ⇒ Object

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

Response struct representing credit entitlement cart details for a subscription

Parameters:

  • credit_entitlement_id (String)
  • credit_entitlement_name (String)
  • credits_amount (String)
  • overage_balance (String) —

    Customer’s current overage balance for this entitlement

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

    Controls how overage is handled at the end of a billing cycle.

  • overage_enabled (Boolean)
  • product_id (String)
  • remaining_balance (String) —

    Customer’s current remaining credit balance for this entitlement

  • rollover_enabled (Boolean)
  • unit (String) —

    Unit label for the credit entitlement (e.g., “API Calls”, “Tokens”)

  • expires_after_days (Integer, nil) (defaults to: nil)
  • low_balance_threshold_percent (Integer, nil) (defaults to: nil)
  • max_rollover_count (Integer, nil) (defaults to: nil)
  • overage_limit (String, nil) (defaults to: nil)
  • 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_cart_response.rb', line 102

Instance Attribute Details

#credit_entitlement_id ⇒ String

Returns:

  • (String) 


9
 
# File 'lib/dodopayments/models/credit_entitlement_cart_response.rb', line 9

required :credit_entitlement_id, String

#credit_entitlement_name ⇒ String

Returns:

  • (String) 


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

required :credit_entitlement_name, String

#credits_amount ⇒ String

Returns:

  • (String) 


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

required :credits_amount, String

#expires_after_days ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :expires_after_days, Integer, nil?: true

#low_balance_threshold_percent ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :low_balance_threshold_percent, Integer, nil?: true

#max_rollover_count ⇒ Integer?

Returns:

  • (Integer, nil) 


80
 
# File 'lib/dodopayments/models/credit_entitlement_cart_response.rb', line 80

optional :max_rollover_count, Integer, nil?: true

#overage_balance ⇒ String

Customer’s current overage balance for this entitlement

Returns:

  • (String) 


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

required :overage_balance, String

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

Controls how overage is handled at the end of a billing cycle.

| Preset | Charge at billing | Credits reduce overage | Preserve overage at reset | | ————————– | :—————: | :——————–: | :———————–: | | ‘forgive_at_reset` | No | No | No | | `invoice_at_billing` | Yes | No | No | | `carry_deficit` | No | No | Yes | | `carry_deficit_auto_repay` | No | Yes | Yes |

Returns:



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

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

#overage_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#overage_limit ⇒ String?

Returns:

  • (String, nil) 


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

optional :overage_limit, String, nil?: true

#product_id ⇒ String

Returns:

  • (String) 


48
 
# File 'lib/dodopayments/models/credit_entitlement_cart_response.rb', line 48

required :product_id, String

#remaining_balance ⇒ String

Customer’s current remaining credit balance for this entitlement

Returns:

  • (String) 


54
 
# File 'lib/dodopayments/models/credit_entitlement_cart_response.rb', line 54

required :remaining_balance, String

#rollover_enabled ⇒ Boolean

Returns:

  • (Boolean) 


59
 
# File 'lib/dodopayments/models/credit_entitlement_cart_response.rb', line 59

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

#rollover_percentage ⇒ Integer?

Returns:

  • (Integer, nil) 


90
 
# File 'lib/dodopayments/models/credit_entitlement_cart_response.rb', line 90

optional :rollover_percentage, Integer, nil?: true

#rollover_timeframe_count ⇒ Integer?

Returns:

  • (Integer, nil) 


95
 
# File 'lib/dodopayments/models/credit_entitlement_cart_response.rb', line 95

optional :rollover_timeframe_count, Integer, nil?: true

#rollover_timeframe_interval ⇒ Symbol, ...

Returns:



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

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

#unit ⇒ String

Unit label for the credit entitlement (e.g., “API Calls”, “Tokens”)

Returns:

  • (String) 


65
 
# File 'lib/dodopayments/models/credit_entitlement_cart_response.rb', line 65

required :unit, String