Class: Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::CreditEntitlement

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/checkout_session_preview_response.rb,
sig/dodopayments/models/checkout_session_preview_response.rbs

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_entitlements:, currency:, discounted_price:, is_subscription:, is_usage_based:, meters:, og_currency:, og_price:, product_id:, quantity:, tax_category:, tax_inclusive:, tax_rate:, addons: nil, description: nil, discount_amount: nil, discount_cycle: nil, name: nil, tax: nil) ⇒ Object

Parameters:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/dodopayments/models/checkout_session_preview_response.rb', line 310

class CreditEntitlement < Dodopayments::Internal::Type::BaseModel
  # @!attribute credit_entitlement_id
  #   ID of the credit entitlement
  #
  #   @return [String]
  required :credit_entitlement_id, String

  # @!attribute credit_entitlement_name
  #   Name of the credit entitlement
  #
  #   @return [String]
  required :credit_entitlement_name, String

  # @!attribute credit_entitlement_unit
  #   Unit label (e.g. "API Calls", "Tokens")
  #
  #   @return [String]
  required :credit_entitlement_unit, String

  # @!attribute credits_amount
  #   Number of credits granted
  #
  #   @return [String]
  required :credits_amount, String

  # @!method initialize(credit_entitlement_id:, credit_entitlement_name:, credit_entitlement_unit:, credits_amount:)
  #   Minimal credit entitlement info shown at checkout — what credits the customer
  #   will receive
  #
  #   @param credit_entitlement_id [String] ID of the credit entitlement
  #
  #   @param credit_entitlement_name [String] Name of the credit entitlement
  #
  #   @param credit_entitlement_unit [String] Unit label (e.g. "API Calls", "Tokens")
  #
  #   @param credits_amount [String] Number of credits granted
end

Instance Attribute Details

#credit_entitlement_id ⇒ String

ID of the credit entitlement

Parameters:

  • value (String)

Returns:

  • (String) 


315
 
# File 'lib/dodopayments/models/checkout_session_preview_response.rb', line 315

required :credit_entitlement_id, String

#credit_entitlement_name ⇒ String

Name of the credit entitlement

Parameters:

  • value (String)

Returns:

  • (String) 


321
 
# File 'lib/dodopayments/models/checkout_session_preview_response.rb', line 321

required :credit_entitlement_name, String

#credit_entitlement_unit ⇒ String

Unit label (e.g. "API Calls", "Tokens")

Parameters:

  • value (String)

Returns:

  • (String) 


327
 
# File 'lib/dodopayments/models/checkout_session_preview_response.rb', line 327

required :credit_entitlement_unit, String

#credits_amount ⇒ String

Number of credits granted

Parameters:

  • value (String)

Returns:

  • (String) 


333
 
# File 'lib/dodopayments/models/checkout_session_preview_response.rb', line 333

required :credits_amount, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


236
 
# File 'sig/dodopayments/models/checkout_session_preview_response.rbs', line 236

def to_hash: -> {