Class: WhopSDK::Models::CheckoutConfigurationListResponse

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

Overview

See Also:

  • WhopSDK::Resources::CheckoutConfigurations#list

Defined Under Namespace

Modules: Mode Classes: PaymentMethodConfiguration, Plan

Instance Attribute Summary collapse

Class Method 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(disabled: nil, enabled: nil, include_platform_defaults: nil) ⇒ Object

Payment method overrides for this checkout. null when it uses the plan or platform defaults.

Parameters:

  • disabled (Array<String>) (defaults to: nil) —

    Payment methods explicitly disabled for checkout.

  • enabled (Array<String>) (defaults to: nil) —

    Payment methods explicitly enabled for checkout.

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

    Whether platform default payment methods are included.




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

Instance Attribute Details

#affiliate_code ⇒ String?

Affiliate code applied at checkout, or null when none is set.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :affiliate_code, String, nil?: true

#company_id ⇒ String

Account ID, prefixed biz_.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :company_id, String

#created_at ⇒ String

When the checkout configuration was created, as an ISO 8601 timestamp.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :created_at, String

#currency ⇒ String?

Currency used for setup-mode payment method availability; defaults to usd when omitted.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :currency, String, nil?: true

#id ⇒ String

Checkout configuration ID, prefixed ch_.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#metadata ⇒ Object?

Custom key-value metadata copied to payments and memberships. null without the checkout_configuration:basic:read scope.

Parameters:

  • value (top, nil)

Returns:

  • (Object, nil) 


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

optional :metadata, WhopSDK::Internal::Type::Unknown, nil?: true

#mode ⇒ Symbol, WhopSDK::Models::CheckoutConfigurationListResponse::Mode

Checkout mode: payment collects payment now; setup saves payment details for later.

Parameters:

  • value (WhopSDK::Models::CheckoutConfigurationListResponse::mode)

Returns:



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

required :mode, enum: -> { WhopSDK::Models::CheckoutConfigurationListResponse::Mode }

#payment_method_configuration ⇒ WhopSDK::Models::CheckoutConfigurationListResponse::PaymentMethodConfiguration?

Payment method overrides for this checkout. null when it uses the plan or platform defaults.

Parameters:

Returns:



63
64
65
 
# File 'lib/whop_sdk/models/checkout_configuration_list_response.rb', line 63

optional :payment_method_configuration,
-> { WhopSDK::Models::CheckoutConfigurationListResponse::PaymentMethodConfiguration },
nil?: true

#plan ⇒ WhopSDK::Models::CheckoutConfigurationListResponse::Plan?

Plan used for payment checkout. null in setup mode.

Parameters:

Returns:



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

optional :plan, -> { WhopSDK::Models::CheckoutConfigurationListResponse::Plan }, nil?: true

#purchase_url ⇒ String?

Checkout URL you can send to customers.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :purchase_url, String, nil?: true

#redirect_url ⇒ String?

URL customers are sent to after checkout, or null when no redirect is configured.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :redirect_url, String, nil?: true

#three_ds_level ⇒ String?

3D Secure behavior for this checkout, or null to use the account default.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :three_ds_level, String, nil?: true

#updated_at ⇒ String

When the checkout configuration was last updated, as an ISO 8601 timestamp.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :updated_at, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/whop_sdk/models/checkout_configuration_list_response.rbs', line 63

def to_hash: -> {