Class: Dodopayments::Models::SubscriptionCreateResponse

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

Overview

See Also:

  • Dodopayments::Resources::Subscriptions#create

Defined Under Namespace

Classes: OneTimeProductCart

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 ⇒ Object 



50
 
# File 'sig/dodopayments/models/subscription_create_response.rbs', line 50

def initialize: (

Instance Attribute Details

#addons ⇒ Array<Dodopayments::Models::AddonCartResponseItem>

Addons associated with this subscription

Parameters:

Returns:



11
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 11

required :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AddonCartResponseItem] }

#client_secret ⇒ String?

Client secret used to load Dodo checkout SDK NOTE : Dodo checkout SDK will be coming soon

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


56
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 56

optional :client_secret, String, nil?: true

#customer ⇒ Dodopayments::Models::CustomerLimitedDetails

Customer details associated with this subscription

Parameters:

Returns:



17
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 17

required :customer, -> { Dodopayments::CustomerLimitedDetails }

#discount_id ⇒ String?

Deprecated.

Use discounts instead.

DEPRECATED: Use discount_ids instead. Returns the first discount's ID if present.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :discount_id, String, nil?: true

#discount_ids ⇒ Array<String>?

All stacked discount IDs applied, in order of application

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


71
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 71

optional :discount_ids, Dodopayments::Internal::Type::ArrayOf[String], nil?: true

#expires_on ⇒ Time?

Expiry timestamp of the payment link

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


77
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 77

optional :expires_on, Time, nil?: true

#metadata ⇒ Hash{Symbol=>String, Float, Boolean}

Additional metadata associated with the subscription

Parameters:

  • value (Dodopayments::Models::metadata)

Returns:

  • (Hash{Symbol=>String, Float, Boolean}) 


23
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 23

required :metadata, -> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::MetadataItem] }

#one_time_product_cart ⇒ Array<Dodopayments::Models::SubscriptionCreateResponse::OneTimeProductCart>?

One time products associated with the purchase of subscription

Parameters:

Returns:



83
84
85
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 83

optional :one_time_product_cart,
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::SubscriptionCreateResponse::OneTimeProductCart] },
nil?: true

#payment_id ⇒ String

First payment id for the subscription

Parameters:

  • value (String)

Returns:

  • (String) 


29
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 29

required :payment_id, String

#payment_link ⇒ String?

URL to checkout page

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


91
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 91

optional :payment_link, String, nil?: true

#payment_method_required ⇒ Boolean

False when the customer can start this subscription with no card. True for every other subscription.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


36
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 36

required :payment_method_required, Dodopayments::Internal::Type::Boolean

#recurring_pre_tax_amount ⇒ Integer

Tax will be added to the amount and charged to the customer on each billing cycle

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :recurring_pre_tax_amount, Integer

#subscription_id ⇒ String

Unique identifier for the subscription

Parameters:

  • value (String)

Returns:

  • (String) 


49
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 49

required :subscription_id, String

#trial_amount ⇒ Integer?

Per-unit trial amount after discounts, in the price currency's minor units (pre-quantity, pre-tax). Null for a free trial or no trial.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


98
 
# File 'lib/dodopayments/models/subscription_create_response.rb', line 98

optional :trial_amount, Integer, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


67
 
# File 'sig/dodopayments/models/subscription_create_response.rbs', line 67

def to_hash: -> {