Class: Dodopayments::Models::SubscriptionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::SubscriptionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/subscription_create_params.rb

Overview

See Also:

• Resources::Subscriptions#create

Instance Attribute Summary

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

  Attach addons to this subscription.

• #allowed_payment_method_types ⇒ Array<Symbol, Dodopayments::Models::PaymentMethodTypes>^?

  List of payment methods allowed during checkout.

• #billing ⇒ Dodopayments::Models::BillingAddress

  Billing address information for the subscription.

• #billing_currency ⇒ Symbol, ...

  Fix the currency in which the end customer is billed.

• #customer ⇒ Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer

  Customer details for the subscription.

• #discount_code ⇒ String^?

  Discount Code to apply to the subscription.

• #force_3ds ⇒ Boolean^?

  Override merchant default 3DS behaviour for this subscription.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional metadata for the subscription Defaults to empty if not specified.

• #on_demand ⇒ Dodopayments::Models::OnDemandSubscription^?
• #payment_link ⇒ Boolean^?

  If true, generates a payment link.

• #product_id ⇒ String

  Unique identifier of the product to subscribe to.

• #quantity ⇒ Integer

  Number of units to subscribe for.

• #return_url ⇒ String^?

  Optional URL to redirect after successful subscription creation.

• #show_saved_payment_methods ⇒ Boolean^?

  Display saved payment methods of a returning customer False by default.

• #tax_id ⇒ String^?

  Tax ID in case the payment is B2B.

• #trial_period_days ⇒ Integer^?

  Optional trial period in days If specified, this value overrides the trial period set in the product’s price Must be between 0 and 10000 days.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(billing: , customer: , product_id: , quantity: , addons: nil, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, metadata: nil, on_demand: nil, payment_link: nil, return_url: nil, show_saved_payment_methods: nil, tax_id: nil, trial_period_days: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see SubscriptionCreateParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(billing: , customer: , product_id: , quantity: , addons: nil, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, force_3ds: nil, metadata: nil, on_demand: nil, payment_link: nil, return_url: nil, show_saved_payment_methods: nil, tax_id: nil, trial_period_days: nil, request_options: {}) ⇒ Object

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

Parameters:

• billing (Dodopayments::Models::BillingAddress) (defaults to: ) —

  Billing address information for the subscription

• customer (Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer) (defaults to: ) —

  Customer details for the subscription

• product_id (String) (defaults to: ) —

  Unique identifier of the product to subscribe to

• quantity (Integer) (defaults to: ) —

  Number of units to subscribe for. Must be at least 1.

• addons (Array<Dodopayments::Models::AttachAddon>, nil) (defaults to: nil) —

  Attach addons to this subscription

• allowed_payment_method_types (Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil) (defaults to: nil) —

  List of payment methods allowed during checkout.

• billing_currency (Symbol, Dodopayments::Models::Currency, nil) (defaults to: nil) —

  Fix the currency in which the end customer is billed.

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

  Discount Code to apply to the subscription

• force_3ds (Boolean, nil) (defaults to: nil) —

  Override merchant default 3DS behaviour for this subscription

• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  Additional metadata for the subscription

• on_demand (Dodopayments::Models::OnDemandSubscription, nil) (defaults to: nil)
• payment_link (Boolean, nil) (defaults to: nil) —

  If true, generates a payment link.

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

  Optional URL to redirect after successful subscription creation

• show_saved_payment_methods (Boolean) (defaults to: nil) —

  Display saved payment methods of a returning customer

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

  Tax ID in case the payment is B2B. If tax id validation fails the payment creati

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

  Optional trial period in days

• request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/dodopayments/models/subscription_create_params.rb', line 115

Instance Attribute Details

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

Attach addons to this subscription

Returns:

• (Array<Dodopayments::Models::AttachAddon>, nil)

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

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

#allowed_payment_method_types ⇒ Array<Symbol, Dodopayments::Models::PaymentMethodTypes>^?

List of payment methods allowed during checkout.

Customers will never see payment methods that are not in this list. However, adding a method here **does not guarantee** customers will see it. Availability still depends on other factors (e.g., customer location, merchant settings).

Returns:

• (Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil)

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

optional :allowed_payment_method_types,
-> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::PaymentMethodTypes] },
nil?: true

#billing ⇒ Dodopayments::Models::BillingAddress

Billing address information for the subscription

Returns:

• (Dodopayments::Models::BillingAddress)

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

required :billing, -> { Dodopayments::BillingAddress }

#billing_currency ⇒ Symbol, ...

Fix the currency in which the end customer is billed. If Dodo Payments cannot support that currency for this transaction, it will not proceed

Returns:

• (Symbol, Dodopayments::Models::Currency, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 58

optional :billing_currency, enum: -> { Dodopayments::Currency }, nil?: true

#customer ⇒ Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer

Customer details for the subscription

Returns:

• (Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 20

required :customer, union: -> { Dodopayments::CustomerRequest }

#discount_code ⇒ String^?

Discount Code to apply to the subscription

Returns:

• (String, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 64

optional :discount_code, String, nil?: true

#force_3ds ⇒ Boolean^?

Override merchant default 3DS behaviour for this subscription

Returns:

• (Boolean, nil)

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

optional :force_3ds, Dodopayments::Internal::Type::Boolean, nil?: true

#metadata ⇒ Hash{Symbol=>String}^?

Additional metadata for the subscription Defaults to empty if not specified

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 76

optional :metadata, Dodopayments::Internal::Type::HashOf[String]

#on_demand ⇒ Dodopayments::Models::OnDemandSubscription^?

Returns:

• (Dodopayments::Models::OnDemandSubscription, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 81

optional :on_demand, -> { Dodopayments::OnDemandSubscription }, nil?: true

#payment_link ⇒ Boolean^?

If true, generates a payment link. Defaults to false if not specified.

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 87

optional :payment_link, Dodopayments::Internal::Type::Boolean, nil?: true

#product_id ⇒ String

Unique identifier of the product to subscribe to

Returns:

• (String)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 26

required :product_id, String

#quantity ⇒ Integer

Number of units to subscribe for. Must be at least 1.

Returns:

• (Integer)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 32

required :quantity, Integer

#return_url ⇒ String^?

Optional URL to redirect after successful subscription creation

Returns:

• (String, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 93

optional :return_url, String, nil?: true

#show_saved_payment_methods ⇒ Boolean^?

Display saved payment methods of a returning customer False by default

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 99

optional :show_saved_payment_methods, Dodopayments::Internal::Type::Boolean

#tax_id ⇒ String^?

Tax ID in case the payment is B2B. If tax id validation fails the payment creation will fail

Returns:

• (String, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 106

optional :tax_id, String, nil?: true

#trial_period_days ⇒ Integer^?

Optional trial period in days If specified, this value overrides the trial period set in the product’s price Must be between 0 and 10000 days

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/subscription_create_params.rb', line 113

optional :trial_period_days, Integer, nil?: true