Class: WhopSDK::Models::PlanCreateParams::CheckoutStyling

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

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(company_id:, product_id:, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: nil, stock: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {}) ⇒ Object

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

Parameters:

  • company_id (String) —

    The unique identifier of the company to create this plan for.

  • product_id (String) —

    The unique identifier of the product to attach this plan to.

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

    The number of days between recurring charges. For example, 30 for monthly or 365

  • checkout_styling (WhopSDK::Models::PlanCreateParams::CheckoutStyling, nil) (defaults to: nil) —

    Checkout styling overrides for this plan. Pass null to inherit from the company

  • currency (Symbol, WhopSDK::Models::Currency, nil) (defaults to: nil) —

    The available currencies on the platform

  • custom_fields (Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil) (defaults to: nil) —

    An array of custom field definitions to collect from customers at checkout.

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

    A text description of the plan displayed to customers on the product page.

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

    The number of days until the membership expires and access is revoked. Used for

  • image (WhopSDK::Models::PlanCreateParams::Image, nil) (defaults to: nil) —

    An image displayed on the product page to represent this plan.

  • initial_price (Float, nil) (defaults to: nil) —

    The amount charged on the first purchase. For one-time plans, this is the full p

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

    Private notes visible only to the business owner. Not shown to customers.

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

    Whether this plan uses legacy payment method controls.

  • override_tax_type (Symbol, WhopSDK::Models::TaxType, nil) (defaults to: nil) —

    Whether or not the tax is included in a plan’s price (or if it hasn’t been set u

  • payment_method_configuration (WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil) (defaults to: nil) —

    Explicit payment method configuration for the plan. When not provided, the compa

  • plan_type (Symbol, WhopSDK::Models::PlanType, nil) (defaults to: nil) —

    The type of plan that can be attached to a product

  • release_method (Symbol, WhopSDK::Models::ReleaseMethod, nil) (defaults to: nil) —

    The methods of how a plan can be released.

  • renewal_price (Float, nil) (defaults to: nil) —

    The amount charged each billing period for recurring plans. Provided in the plan

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

    The number of installment payments required before the subscription pauses.

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

    The maximum number of units available for purchase. Ignored when unlimited_stock

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

    The display name of the plan shown to customers on the product page.

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

    The number of free trial days before the first charge on a recurring plan.

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

    Whether the plan has unlimited stock. When true, the stock field is ignored. Def

  • visibility (Symbol, WhopSDK::Models::Visibility, nil) (defaults to: nil) —

    Visibility of a resource

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


214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/whop_sdk/models/plan_create_params.rb', line 214

class CheckoutStyling < WhopSDK::Internal::Type::BaseModel
  # @!attribute border_style
  #   The different border-radius styles available for checkout pages.
  #
  #   @return [Symbol, WhopSDK::Models::CheckoutShape, nil]
  optional :border_style, enum: -> { WhopSDK::CheckoutShape }, nil?: true

  # @!attribute button_color
  #   A hex color code for the button color (e.g. #FF5733).
  #
  #   @return [String, nil]
  optional :button_color, String, nil?: true

  # @!attribute font_family
  #   The different font families available for checkout pages.
  #
  #   @return [Symbol, WhopSDK::Models::CheckoutFont, nil]
  optional :font_family, enum: -> { WhopSDK::CheckoutFont }, nil?: true

  # @!method initialize(border_style: nil, button_color: nil, font_family: nil)
  #   Checkout styling overrides for this plan. Pass null to inherit from the company
  #   default.
  #
  #   @param border_style [Symbol, WhopSDK::Models::CheckoutShape, nil] The different border-radius styles available for checkout pages.
  #
  #   @param button_color [String, nil] A hex color code for the button color (e.g. #FF5733).
  #
  #   @param font_family [Symbol, WhopSDK::Models::CheckoutFont, nil] The different font families available for checkout pages.
end

Instance Attribute Details

#border_style ⇒ Symbol, ...

The different border-radius styles available for checkout pages.

Returns:



219
 
# File 'lib/whop_sdk/models/plan_create_params.rb', line 219

optional :border_style, enum: -> { WhopSDK::CheckoutShape }, nil?: true

#button_color ⇒ String?

A hex color code for the button color (e.g. #FF5733).

Returns:

  • (String, nil) 


225
 
# File 'lib/whop_sdk/models/plan_create_params.rb', line 225

optional :button_color, String, nil?: true

#font_family ⇒ Symbol, ...

The different font families available for checkout pages.

Returns:



231
 
# File 'lib/whop_sdk/models/plan_create_params.rb', line 231

optional :font_family, enum: -> { WhopSDK::CheckoutFont }, nil?: true