Class: WhopSDK::Models::PaymentCreateParams::Body::CreatePaymentInputWithPlan::Plan::Product

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

Overview

See Also:

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from WhopSDK::Internal::Type::BaseModel

Instance Attribute Details

#collect_shipping_address ⇒ Boolean?

Whether or not to collect shipping information at checkout from the customer.

Returns:

  • (Boolean, nil) 


240
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 240

optional :collect_shipping_address, WhopSDK::Internal::Type::Boolean, nil?: true

#custom_statement_descriptor ⇒ String?

The custom statement descriptor for the product i.e. WHOP*SPORTS, must be between 5 and 22 characters, contain at least one letter, and not contain any of the following characters: <, >, , ‘, “

Returns:

  • (String, nil) 


248
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 248

optional :custom_statement_descriptor, String, nil?: true

#description ⇒ String?

A written description of the product.

Returns:

  • (String, nil) 


254
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 254

optional :description, String, nil?: true

#external_identifier ⇒ String

A unique ID used to find or create a product. When provided during creation, we will look for an existing product with this external identifier — if found, it will be updated; otherwise, a new product will be created.

Returns:

  • (String) 


228
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 228

required :external_identifier, String

#global_affiliate_percentage ⇒ Float?

The percentage of the revenue that goes to the global affiliate program.

Returns:

  • (Float, nil) 


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

optional :global_affiliate_percentage, Float, nil?: true

#global_affiliate_status ⇒ Symbol, ...

The different statuses of the global affiliate program for a product.

Returns:



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

optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true

#headline ⇒ String?

The headline of the product.

Returns:

  • (String, nil) 


272
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 272

optional :headline, String, nil?: true

#product_tax_code_id ⇒ String?

The ID of the product tax code to apply to this product.

Returns:

  • (String, nil) 


278
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 278

optional :product_tax_code_id, String, nil?: true

#redirect_purchase_url ⇒ String?

The URL to redirect the customer to after a purchase.

Returns:

  • (String, nil) 


284
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 284

optional :redirect_purchase_url, String, nil?: true

#route ⇒ String?

The route of the product.

Returns:

  • (String, nil) 


290
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 290

optional :route, String, nil?: true

#title ⇒ String

The title of the product.

Returns:

  • (String) 


234
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 234

required :title, String

#visibility ⇒ Symbol, ...

Visibility of a resource

Returns:



296
 
# File 'lib/whop_sdk/models/payment_create_params.rb', line 296

optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true