Class: WhopSDK::Models::Account

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::Account

Defined in:

lib/whop_sdk/models/account.rb,
sig/whop_sdk/models/account.rbs

Overview

See Also:

• WhopSDK::Resources::Accounts#create

Defined Under Namespace

Classes: Balance, Capabilities, RecommendedAction, RequiredAction, Wallet

Instance Attribute Summary

• #balances ⇒ Array<WhopSDK::Models::Account::Balance>
• #banner_image_url ⇒ String^?

  Account banner image URL.

• #business_address ⇒ Object^?

  Account business address used to calculate tax, with line1, line2, city, state, postal_code, and country.

• #business_type ⇒ String^?

  High-level business category for the account.

• #capabilities ⇒ WhopSDK::Models::Account::Capabilities^?

  Payment rails enabled for this account, each active, inactive, or pending (onboarding or review in progress).

• #country ⇒ String^?

  Country where the account is located.

• #created_at ⇒ String

  When the account was created, as an ISO 8601 timestamp.

• #description ⇒ String^?

  Account promotional description.

• #email ⇒ String^?

  Account owner email address.

• #home_preferences ⇒ Array<String>
• #id ⇒ String

  Account ID, prefixed biz_.

• #industry_group ⇒ String^?

  Account industry group.

• #industry_type ⇒ String^?

  Specific industry vertical for the account.

• #invoice_prefix ⇒ String^?

  Prefix used for account invoices.

• #logo_url ⇒ String^?

  Account logo image URL.

• #metadata ⇒ Object

  Arbitrary key/value metadata supplied at account creation.

• #onboarding_type ⇒ String^?

  Type of onboarding the account has completed.

• #opengraph_image_url ⇒ String^?

  Account Open Graph image URL.

• #opengraph_image_variant ⇒ String^?

  Account Open Graph image variant.

• #other_business_description ⇒ String^?

  Business type details when business_type is other.

• #other_industry_description ⇒ String^?

  Industry details when industry_type is other.

• #parent_account_id ⇒ String^?

  Parent account ID for connected accounts.

• #product_tax_code ⇒ Object^?

  Tax classification code applied by default to the account's products, with id, name, and product_type.

• #recommended_actions ⇒ Array<WhopSDK::Models::Account::RecommendedAction>^? deprecated Deprecated.
• #require_2fa ⇒ Boolean

  Whether authorized users must enable two-factor authentication.

• #required_actions ⇒ Array<WhopSDK::Models::Account::RequiredAction>^?
• #route ⇒ String

  Account public route identifier.

• #send_customer_emails ⇒ Boolean

  Whether Whop sends transactional emails to customers on behalf of this account.

• #show_joined_whops ⇒ Boolean

  Whether the account appears in joined whops on other accounts.

• #show_reviews_dtc ⇒ Boolean

  Whether reviews are displayed on direct-to-consumer product pages.

• #show_user_directory ⇒ Boolean

  Whether the account shows users in the user directory.

• #social_links ⇒ Array<WhopSDK::Models::AccountSocialLink>
• #status ⇒ String^?

  Whether the account can operate on Whop: active or suspended.

• #store_page_config ⇒ Object

  Account store page display configuration.

• #target_audience ⇒ String^?

  Target audience for this account.

• #tax_identifiers ⇒ Array<Object>

  Account tax/VAT registrations, each with id, tax_id_type, and tax_id_value.

• #tax_remitted_by ⇒ String^?

  Who calculates and remits tax for the account: whop (Whop calculates and remits), self (Whop calculates; the account collects and remits), or none (neither; the account is responsible).

• #title ⇒ String

  Account display name.

• #total_earned_usd ⇒ Float^?

  Account lifetime sales, normalized to USD.

• #total_usd ⇒ String^?

  Total USD value across balances with known exchange rates.

• #use_logo_as_opengraph_image_fallback ⇒ Boolean

  Whether the account uses its logo as the fallback Open Graph image.

• #verification ⇒ Object

  Account identity verification status for the individual (KYC) and business (KYB) profiles.

• #wallet ⇒ WhopSDK::Models::Account::Wallet^?

  Account primary crypto wallet, or null if none has been provisioned.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(balance:, breakdown:, icon_url:, name:, price_usd:, symbol:, value_usd:) ⇒ Object constructor

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

• #to_hash ⇒ {

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(balance:, breakdown:, icon_url:, name:, price_usd:, symbol:, value_usd:) ⇒ Object

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

Account holdings, each with USD value. Empty when total_usd is null.

Parameters:

• balance (String) —

  Total amount held in native units, as a decimal string.

• breakdown (Object) —

  Balance split into available, pending, and reserve amounts, as native-unit decim

• icon_url (String, nil) —

  Holding icon URL.

• name (String) —

  The holding's display name

• price_usd (Float, nil) —

  USD price per unit, or null when no exchange rate is available.

• symbol (String) —

  Holding display symbol, such as USDT, cbBTC, or EUR.

• value_usd (String, nil) —

  Holding USD value, or null when no exchange rate is available.

# File 'lib/whop_sdk/models/account.rb', line 417

Instance Attribute Details

#balances ⇒ Array<WhopSDK::Models::Account::Balance>

Parameters:

• value (::Array[WhopSDK::Account::Balance])

Returns:

• (Array<WhopSDK::Models::Account::Balance>)

# File 'lib/whop_sdk/models/account.rb', line 16

required :balances, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Account::Balance] }

#banner_image_url ⇒ String^?

Account banner image URL.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 22

required :banner_image_url, String, nil?: true

#business_address ⇒ Object^?

Account business address used to calculate tax, with line1, line2, city, state, postal_code, and country. null when no address is set.

Parameters:

• value (top, nil)

Returns:

• (Object, nil)

# File 'lib/whop_sdk/models/account.rb', line 29

required :business_address, WhopSDK::Internal::Type::Unknown, nil?: true

#business_type ⇒ String^?

High-level business category for the account.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 35

required :business_type, String, nil?: true

#capabilities ⇒ WhopSDK::Models::Account::Capabilities^?

Payment rails enabled for this account, each active, inactive, or pending (onboarding or review in progress). Computed only on retrieve and me for callers with company:balance:read scope; null otherwise.

Parameters:

• value (WhopSDK::Account::Capabilities, nil)

Returns:

• (WhopSDK::Models::Account::Capabilities, nil)

# File 'lib/whop_sdk/models/account.rb', line 43

required :capabilities, -> { WhopSDK::Account::Capabilities }, nil?: true

#country ⇒ String^?

Country where the account is located.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :country, String, nil?: true

#created_at ⇒ String

When the account was created, as an ISO 8601 timestamp.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/whop_sdk/models/account.rb', line 55

required :created_at, String

#description ⇒ String^?

Account promotional description.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 61

required :description, String, nil?: true

#email ⇒ String^?

Account owner email address.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 67

required :email, String, nil?: true

#home_preferences ⇒ Array<String>

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

# File 'lib/whop_sdk/models/account.rb', line 72

required :home_preferences, WhopSDK::Internal::Type::ArrayOf[String]

#id ⇒ String

Account ID, prefixed biz_.

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#industry_group ⇒ String^?

Account industry group.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 78

required :industry_group, String, nil?: true

#industry_type ⇒ String^?

Specific industry vertical for the account.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :industry_type, String, nil?: true

#invoice_prefix ⇒ String^?

Prefix used for account invoices.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :invoice_prefix, String, nil?: true

#logo_url ⇒ String^?

Account logo image URL.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 96

required :logo_url, String, nil?: true

#metadata ⇒ Object

Arbitrary key/value metadata supplied at account creation.

Parameters:

• value (top)

Returns:

• (Object)

# File 'lib/whop_sdk/models/account.rb', line 102

required :metadata, WhopSDK::Internal::Type::Unknown

#onboarding_type ⇒ String^?

Type of onboarding the account has completed.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 108

required :onboarding_type, String, nil?: true

#opengraph_image_url ⇒ String^?

Account Open Graph image URL.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 114

required :opengraph_image_url, String, nil?: true

#opengraph_image_variant ⇒ String^?

Account Open Graph image variant.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 120

required :opengraph_image_variant, String, nil?: true

#other_business_description ⇒ String^?

Business type details when business_type is other.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 126

required :other_business_description, String, nil?: true

#other_industry_description ⇒ String^?

Industry details when industry_type is other.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :other_industry_description, String, nil?: true

#parent_account_id ⇒ String^?

Parent account ID for connected accounts.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 138

required :parent_account_id, String, nil?: true

#product_tax_code ⇒ Object^?

Tax classification code applied by default to the account's products, with id, name, and product_type. null when no default is set.

Parameters:

• value (top, nil)

Returns:

• (Object, nil)

# File 'lib/whop_sdk/models/account.rb', line 145

required :product_tax_code, WhopSDK::Internal::Type::Unknown, nil?: true

#recommended_actions ⇒ Array<WhopSDK::Models::Account::RecommendedAction>^?

Deprecated.

DEPRECATED: Use the GET /accounts/{account_id}/recommend_actions endpoint instead.

Parameters:

• value (::Array[WhopSDK::Account::RecommendedAction], nil)

Returns:

• (Array<WhopSDK::Models::Account::RecommendedAction>, nil)

# File 'lib/whop_sdk/models/account.rb', line 154

required :recommended_actions,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Account::RecommendedAction] },
nil?: true

#require_2fa ⇒ Boolean

Whether authorized users must enable two-factor authentication.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/whop_sdk/models/account.rb', line 162

required :require_2fa, WhopSDK::Internal::Type::Boolean

#required_actions ⇒ Array<WhopSDK::Models::Account::RequiredAction>^?

Parameters:

• value (::Array[WhopSDK::Account::RequiredAction], nil)

Returns:

• (Array<WhopSDK::Models::Account::RequiredAction>, nil)

# File 'lib/whop_sdk/models/account.rb', line 167

required :required_actions,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Account::RequiredAction] },
nil?: true

#route ⇒ String

Account public route identifier.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/whop_sdk/models/account.rb', line 175

required :route, String

#send_customer_emails ⇒ Boolean

Whether Whop sends transactional emails to customers on behalf of this account.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/whop_sdk/models/account.rb', line 181

required :send_customer_emails, WhopSDK::Internal::Type::Boolean

#show_joined_whops ⇒ Boolean

Whether the account appears in joined whops on other accounts.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/whop_sdk/models/account.rb', line 187

required :show_joined_whops, WhopSDK::Internal::Type::Boolean

#show_reviews_dtc ⇒ Boolean

Whether reviews are displayed on direct-to-consumer product pages.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

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

required :show_reviews_dtc, WhopSDK::Internal::Type::Boolean

#show_user_directory ⇒ Boolean

Whether the account shows users in the user directory.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/whop_sdk/models/account.rb', line 199

required :show_user_directory, WhopSDK::Internal::Type::Boolean

#social_links ⇒ Array<WhopSDK::Models::AccountSocialLink>

Parameters:

• value (::Array[WhopSDK::AccountSocialLink])

Returns:

• (Array<WhopSDK::Models::AccountSocialLink>)

# File 'lib/whop_sdk/models/account.rb', line 204

required :social_links, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AccountSocialLink] }

#status ⇒ String^?

Whether the account can operate on Whop: active or suspended. Computed only on retrieve and me; null otherwise.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 211

required :status, String, nil?: true

#store_page_config ⇒ Object

Account store page display configuration.

Parameters:

• value (top)

Returns:

• (Object)

# File 'lib/whop_sdk/models/account.rb', line 217

required :store_page_config, WhopSDK::Internal::Type::Unknown

#target_audience ⇒ String^?

Target audience for this account.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 223

required :target_audience, String, nil?: true

#tax_identifiers ⇒ Array<Object>

Account tax/VAT registrations, each with id, tax_id_type, and tax_id_value. Empty when none are set.

Parameters:

• value (::Array[top])

Returns:

• (Array<Object>)

# File 'lib/whop_sdk/models/account.rb', line 230

required :tax_identifiers, WhopSDK::Internal::Type::ArrayOf[WhopSDK::Internal::Type::Unknown]

#tax_remitted_by ⇒ String^?

Who calculates and remits tax for the account: whop (Whop calculates and remits), self (Whop calculates; the account collects and remits), or none (neither; the account is responsible). null until the account enrolls in the Whop tax service.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 239

required :tax_remitted_by, String, nil?: true

#title ⇒ String

Account display name.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/whop_sdk/models/account.rb', line 245

required :title, String

#total_earned_usd ⇒ Float^?

Account lifetime sales, normalized to USD. Computed only on retrieve and me for callers with stats:read scope; null otherwise.

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/whop_sdk/models/account.rb', line 252

required :total_earned_usd, Float, nil?: true

#total_usd ⇒ String^?

Total USD value across balances with known exchange rates. Computed only on single-account reads (retrieve and me); null on list responses, writes, missing balance-read permission, or unavailable balance source.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/account.rb', line 260

required :total_usd, String, nil?: true

#use_logo_as_opengraph_image_fallback ⇒ Boolean

Whether the account uses its logo as the fallback Open Graph image.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/whop_sdk/models/account.rb', line 266

required :use_logo_as_opengraph_image_fallback, WhopSDK::Internal::Type::Boolean

#verification ⇒ Object

Account identity verification status for the individual (KYC) and business (KYB) profiles. Each is null until created, otherwise a status of not_started, pending, approved, or rejected.

Parameters:

• value (top)

Returns:

• (Object)

# File 'lib/whop_sdk/models/account.rb', line 274

required :verification, WhopSDK::Internal::Type::Unknown

#wallet ⇒ WhopSDK::Models::Account::Wallet^?

Account primary crypto wallet, or null if none has been provisioned.

Parameters:

• value (WhopSDK::Account::Wallet, nil)

Returns:

• (WhopSDK::Models::Account::Wallet, nil)

# File 'lib/whop_sdk/models/account.rb', line 280

required :wallet, -> { WhopSDK::Account::Wallet }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/whop_sdk/models/account.rb', line 683

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/whop_sdk/models/account.rbs', line 183

def to_hash: -> {