Class: Dodopayments::Models::ProductItemReq

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/product_item_req.rb

Defined Under Namespace

Classes: CreditEntitlement

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Dodopayments::Internal::Type::BaseModel

Instance Attribute Details

#addons ⇒ Array<Dodopayments::Models::AttachAddon>?

only valid if product is a subscription

Returns:



21
 
# File 'lib/dodopayments/models/product_item_req.rb', line 21

optional :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachAddon] }, nil?: true

#amount ⇒ Integer?

Amount the customer pays if pay_what_you_want is enabled. If disabled then amount will be ignored Represented in the lowest denomination of the currency (e.g., cents for USD). For example, to charge $1.00, pass ‘100`. Only applicable for one time payments

If amount is not set for pay_what_you_want product, customer is allowed to select the amount.

Returns:

  • (Integer, nil) 


33
 
# File 'lib/dodopayments/models/product_item_req.rb', line 33

optional :amount, Integer, nil?: true

#credit_entitlements ⇒ Array<Dodopayments::Models::ProductItemReq::CreditEntitlement>?

Per-checkout-session overrides for credit entitlements already attached to this product. Each entry overrides the ‘credits_amount` granted by the referenced credit entitlement when this checkout session is fulfilled. The credit_entitlement_id must already be attached to the product.

Returns:



42
43
44
 
# File 'lib/dodopayments/models/product_item_req.rb', line 42

optional :credit_entitlements,
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductItemReq::CreditEntitlement] },
nil?: true

#product_id ⇒ String

unique id of the product

Returns:

  • (String) 


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

required :product_id, String

#quantity ⇒ Integer

Returns:

  • (Integer) 


15
 
# File 'lib/dodopayments/models/product_item_req.rb', line 15

required :quantity, Integer