Class: WhopSDK::Models::CheckoutConfigurationListResponse::Plan

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/checkout_configuration_list_response.rb

Overview

See Also:

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(id:, billing_period:, currency:, expiration_days:, initial_price:, plan_type:, release_method:, renewal_price:, trial_period_days:, visibility:) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::CheckoutConfigurationListResponse::Plan for more details.

The plan to use for the checkout configuration

Parameters:

  • id (String) —

    The unique identifier for the plan.

  • billing_period (Integer, nil) —

    The number of days between each recurring charge. Null for one-time plans. For e

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

    The currency used for all prices on this plan (e.g., ‘usd’, ‘eur’). All monetary

  • expiration_days (Integer, nil) —

    The number of days until the membership expires (for expiration-based plans). Fo

  • initial_price (Float) —

    The initial purchase price in the plan’s base_currency (e.g., 49.99 for $49.99).

  • plan_type (Symbol, WhopSDK::Models::PlanType) —

    The billing model for this plan: ‘renewal’ for recurring subscriptions or ‘one_t

  • release_method (Symbol, WhopSDK::Models::ReleaseMethod) —

    The method used to sell this plan: ‘buy_now’ for immediate purchase or ‘waitlist

  • renewal_price (Float) —

    The recurring price charged every billing_period in the plan’s base_currency (e.

  • trial_period_days (Integer, nil) —

    The number of free trial days before the first charge on a renewal plan. Null if

  • visibility (Symbol, WhopSDK::Models::Visibility) —

    Controls whether the plan is visible to customers. When set to ‘hidden’, the pla




# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 224

Instance Attribute Details

#billing_period ⇒ Integer?

The number of days between each recurring charge. Null for one-time plans. For example, 30 for monthly or 365 for annual billing.

Returns:

  • (Integer, nil) 


164
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 164

required :billing_period, Integer, nil?: true

#currency ⇒ Symbol, WhopSDK::Models::Currency

The currency used for all prices on this plan (e.g., ‘usd’, ‘eur’). All monetary amounts on the plan are denominated in this currency.

Returns:



171
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 171

required :currency, enum: -> { WhopSDK::Currency }

#expiration_days ⇒ Integer?

The number of days until the membership expires (for expiration-based plans). For example, 365 for a one-year access pass.

Returns:

  • (Integer, nil) 


178
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 178

required :expiration_days, Integer, nil?: true

#id ⇒ String

The unique identifier for the plan.

Returns:

  • (String) 


157
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 157

required :id, String

#initial_price ⇒ Float

The initial purchase price in the plan’s base_currency (e.g., 49.99 for $49.99). For one-time plans, this is the full price. For renewal plans, this is charged on top of the first renewal_price.

Returns:

  • (Float) 


186
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 186

required :initial_price, Float

#plan_type ⇒ Symbol, WhopSDK::Models::PlanType

The billing model for this plan: ‘renewal’ for recurring subscriptions or ‘one_time’ for single payments.

Returns:



193
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 193

required :plan_type, enum: -> { WhopSDK::PlanType }

#release_method ⇒ Symbol, WhopSDK::Models::ReleaseMethod

The method used to sell this plan: ‘buy_now’ for immediate purchase or ‘waitlist’ for waitlist-based access.

Returns:



200
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 200

required :release_method, enum: -> { WhopSDK::ReleaseMethod }

#renewal_price ⇒ Float

The recurring price charged every billing_period in the plan’s base_currency (e.g., 9.99 for $9.99/period). Zero for one-time plans.

Returns:

  • (Float) 


207
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 207

required :renewal_price, Float

#trial_period_days ⇒ Integer?

The number of free trial days before the first charge on a renewal plan. Null if no trial is configured or the current user has already used a trial for this plan.

Returns:

  • (Integer, nil) 


215
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 215

required :trial_period_days, Integer, nil?: true

#visibility ⇒ Symbol, WhopSDK::Models::Visibility

Controls whether the plan is visible to customers. When set to ‘hidden’, the plan is only accessible via direct link.

Returns:



222
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 222

required :visibility, enum: -> { WhopSDK::Visibility }