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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::CreditEntitlement

Defined in:

lib/dodopayments/models/checkout_session_preview_response.rb

Instance Attribute Summary

• #credit_entitlement_id ⇒ String

  ID of the credit entitlement.

• #credit_entitlement_name ⇒ String

  Name of the credit entitlement.

• #credit_entitlement_unit ⇒ String

  Unit label (e.g. “API Calls”, “Tokens”).

• #credits_amount ⇒ String

  Number of credits granted.

Instance Method Summary

• #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 constructor

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:

• credit_entitlements (Array<Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::CreditEntitlement>) —

  Credit entitlements that will be granted upon purchase

• currency (Symbol, Dodopayments::Models::Currency) —

  the currency in which the calculatiosn were made

• discounted_price (Integer) —

  discounted price

• is_subscription (Boolean) —

  Whether this is a subscription product (affects tax calculation in breakup)

• is_usage_based (Boolean)
• meters (Array<Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Meter>)
• og_currency (Symbol, Dodopayments::Models::Currency) —

  the product currency

• og_price (Integer) —

  original price of the product

• product_id (String) —

  unique id of the product

• quantity (Integer) —

  Quanitity

• tax_category (Symbol, Dodopayments::Models::TaxCategory) —

  tax category

• tax_inclusive (Boolean) —

  Whether tax is included in the price

• tax_rate (Integer) —

  tax rate

• addons (Array<Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::Addon>, nil) (defaults to: nil)
• description (String, nil) (defaults to: nil)
• discount_amount (Integer, nil) (defaults to: nil) —

  discount percentage

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

  number of cycles the discount will apply

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

  name of the product

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

  total tax

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

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

Returns:

• (String)

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

required :credit_entitlement_id, String

#credit_entitlement_name ⇒ String

Name of the credit entitlement

Returns:

• (String)

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

required :credit_entitlement_name, String

#credit_entitlement_unit ⇒ String

Unit label (e.g. “API Calls”, “Tokens”)

Returns:

• (String)

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

required :credit_entitlement_unit, String

#credits_amount ⇒ String

Number of credits granted

Returns:

• (String)

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

required :credits_amount, String