whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/plan_update_params.rb

@@ -19,27 +19,26 @@ module WhopSDK
       optional :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
 
       # @!attribute billing_period
-      #   The number of days between recurring charges. For example, 30 for monthly or 365
-      #   for yearly.
+      #   Recurring billing interval in days, such as 30 for monthly or 365 for annual.
       #
       #   @return [Integer, nil]
       optional :billing_period, Integer, nil?: true
 
       # @!attribute checkout_styling
-      #   Checkout styling overrides for this plan. Pass null to remove all overrides and
-      #   inherit from the company default.
+      #   Checkout styling overrides for this plan.
       #
-      #   @return [WhopSDK::Models::PlanUpdateParams::CheckoutStyling, nil]
-      optional :checkout_styling, -> { WhopSDK::PlanUpdateParams::CheckoutStyling }, nil?: true
+      #   @return [Object, nil]
+      optional :checkout_styling, WhopSDK::Internal::Type::Unknown, nil?: true
 
       # @!attribute currency
-      #   The available currencies on the platform
+      #   The three-letter ISO currency code for the plan's pricing. Defaults to USD.
       #
-      #   @return [Symbol, WhopSDK::Models::Currency, nil]
-      optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
+      #   @return [String, nil]
+      optional :currency, String
 
       # @!attribute custom_fields
       #   An array of custom field definitions to collect from customers at checkout.
+      #   Omitting this field clears existing custom fields.
       #
       #   @return [Array<WhopSDK::Models::PlanUpdateParams::CustomField>, nil]
       optional :custom_fields,
@@ -53,8 +52,7 @@ module WhopSDK
       optional :description, String, nil?: true
 
       # @!attribute expiration_days
-      #   The number of days until the membership expires and access is revoked. For
-      #   example, 365 for one-year access.
+      #   Access duration in days before the membership expires.
       #
       #   @return [Integer, nil]
       optional :expiration_days, Integer, nil?: true
@@ -66,14 +64,13 @@ module WhopSDK
       optional :image, -> { WhopSDK::PlanUpdateParams::Image }, nil?: true
 
       # @!attribute initial_price
-      #   The amount charged on the first purchase. Provided in the plan's currency (e.g.,
-      #   10.43 for $10.43).
+      #   Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.
       #
       #   @return [Float, nil]
       optional :initial_price, Float, nil?: true
 
       # @!attribute internal_notes
-      #   Private notes visible only to the business owner. Not shown to customers.
+      #   Private notes visible only to the account owner. Not shown to customers.
       #
       #   @return [String, nil]
       optional :internal_notes, String, nil?: true
@@ -84,6 +81,14 @@ module WhopSDK
       #   @return [Boolean, nil]
       optional :legacy_payment_method_controls, WhopSDK::Internal::Type::Boolean, nil?: true
 
+      # @!attribute metadata
+      #   Custom key-value pairs to store on the plan. Included in webhook payloads for
+      #   payment and membership events. Max 50 keys, 100 chars per key, 500 chars per
+      #   string value.
+      #
+      #   @return [Object, nil]
+      optional :metadata, WhopSDK::Internal::Type::Unknown, nil?: true
+
       # @!attribute offer_cancel_discount
       #   Whether to offer a retention discount when a customer attempts to cancel.
       #
@@ -91,15 +96,14 @@ module WhopSDK
       optional :offer_cancel_discount, WhopSDK::Internal::Type::Boolean, nil?: true
 
       # @!attribute override_tax_type
-      #   Whether or not the tax is included in a plan's price (or if it hasn't been set
-      #   up)
+      #   Override the default tax classification for this specific plan.
       #
-      #   @return [Symbol, WhopSDK::Models::TaxType, nil]
-      optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
+      #   @return [String, nil]
+      optional :override_tax_type, String
 
       # @!attribute payment_method_configuration
-      #   Explicit payment method configuration for the plan. Sending null removes any
-      #   custom configuration.
+      #   Explicit payment method configuration for the plan. When not provided, the
+      #   account's defaults apply.
       #
       #   @return [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil]
       optional :payment_method_configuration,
@@ -107,8 +111,8 @@ module WhopSDK
                nil?: true
 
       # @!attribute renewal_price
-      #   The amount charged each billing period for recurring plans. Provided in the
-      #   plan's currency (e.g., 10.43 for $10.43).
+      #   The amount charged each billing period for recurring plans, in the plan's
+      #   currency.
       #
       #   @return [Float, nil]
       optional :renewal_price, Float, nil?: true
@@ -122,18 +126,22 @@ module WhopSDK
 
       # @!attribute strike_through_initial_price
       #   A comparison price displayed with a strikethrough for the initial price.
-      #   Provided in the plan's currency (e.g., 19.99 for $19.99).
       #
       #   @return [Float, nil]
       optional :strike_through_initial_price, Float, nil?: true
 
       # @!attribute strike_through_renewal_price
       #   A comparison price displayed with a strikethrough for the renewal price.
-      #   Provided in the plan's currency (e.g., 19.99 for $19.99).
       #
       #   @return [Float, nil]
       optional :strike_through_renewal_price, Float, nil?: true
 
+      # @!attribute three_ds_level
+      #   3D Secure behavior for this plan. Send `null` to inherit the account default.
+      #
+      #   @return [Symbol, WhopSDK::Models::PlanUpdateParams::ThreeDSLevel, nil]
+      optional :three_ds_level, enum: -> { WhopSDK::PlanUpdateParams::ThreeDSLevel }
+
       # @!attribute title
       #   The display name of the plan shown to customers on the product page.
       #
@@ -141,7 +149,7 @@ module WhopSDK
       optional :title, String, nil?: true
 
       # @!attribute trial_period_days
-      #   The number of free trial days before the first charge on a recurring plan.
+      #   Free trial duration before the first recurring charge.
       #
       #   @return [Integer, nil]
       optional :trial_period_days, Integer, nil?: true
@@ -153,12 +161,12 @@ module WhopSDK
       optional :unlimited_stock, WhopSDK::Internal::Type::Boolean, nil?: true
 
       # @!attribute visibility
-      #   Visibility of a resource
+      #   Whether the plan is visible to customers or hidden from public view.
       #
-      #   @return [Symbol, WhopSDK::Models::Visibility, nil]
-      optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
+      #   @return [String, nil]
+      optional :visibility, String
 
-      # @!method initialize(id:, adaptive_pricing_enabled: nil, 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, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
+      # @!method initialize(id:, adaptive_pricing_enabled: nil, 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, metadata: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, three_ds_level: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::PlanUpdateParams} for more details.
       #
@@ -166,119 +174,81 @@ module WhopSDK
       #
       #   @param adaptive_pricing_enabled [Boolean, nil] Whether this plan accepts local currency payments via adaptive pricing.
       #
-      #   @param billing_period [Integer, nil] The number of days between recurring charges. For example, 30 for monthly or 365
+      #   @param billing_period [Integer, nil] Recurring billing interval in days, such as 30 for monthly or 365 for annual.
       #
-      #   @param checkout_styling [WhopSDK::Models::PlanUpdateParams::CheckoutStyling, nil] Checkout styling overrides for this plan. Pass null to remove all overrides and
+      #   @param checkout_styling [Object, nil] Checkout styling overrides for this plan.
       #
-      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #   @param currency [String] The three-letter ISO currency code for the plan's pricing. Defaults to USD.
       #
-      #   @param custom_fields [Array<WhopSDK::Models::PlanUpdateParams::CustomField>, nil] An array of custom field definitions to collect from customers at checkout.
+      #   @param custom_fields [Array<WhopSDK::Models::PlanUpdateParams::CustomField>, nil] An array of custom field definitions to collect from customers at checkout. Omit
       #
       #   @param description [String, nil] A text description of the plan displayed to customers on the product page.
       #
-      #   @param expiration_days [Integer, nil] The number of days until the membership expires and access is revoked. For examp
+      #   @param expiration_days [Integer, nil] Access duration in days before the membership expires.
       #
       #   @param image [WhopSDK::Models::PlanUpdateParams::Image, nil] An image displayed on the product page to represent this plan.
       #
-      #   @param initial_price [Float, nil] The amount charged on the first purchase. Provided in the plan's currency (e.g.,
+      #   @param initial_price [Float, nil] Initial amount charged in the plan's currency, e.g. 10.43 for $10.43.
       #
-      #   @param internal_notes [String, nil] Private notes visible only to the business owner. Not shown to customers.
+      #   @param internal_notes [String, nil] Private notes visible only to the account owner. Not shown to customers.
       #
       #   @param legacy_payment_method_controls [Boolean, nil] Whether this plan uses legacy payment method controls.
       #
+      #   @param metadata [Object, nil] Custom key-value pairs to store on the plan. Included in webhook payloads for pa
+      #
       #   @param offer_cancel_discount [Boolean, nil] Whether to offer a retention discount when a customer attempts to cancel.
       #
-      #   @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
+      #   @param override_tax_type [String] Override the default tax classification for this specific plan.
       #
-      #   @param payment_method_configuration [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. Sending null removes any cus
+      #   @param payment_method_configuration [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. When not provided, the accou
       #
-      #   @param renewal_price [Float, nil] The amount charged each billing period for recurring plans. Provided in the plan
+      #   @param renewal_price [Float, nil] The amount charged each billing period for recurring plans, in the plan's curren
       #
       #   @param stock [Integer, nil] The maximum number of units available for purchase. Ignored when unlimited_stock
       #
-      #   @param strike_through_initial_price [Float, nil] A comparison price displayed with a strikethrough for the initial price. Provide
+      #   @param strike_through_initial_price [Float, nil] A comparison price displayed with a strikethrough for the initial price.
+      #
+      #   @param strike_through_renewal_price [Float, nil] A comparison price displayed with a strikethrough for the renewal price.
       #
-      #   @param strike_through_renewal_price [Float, nil] A comparison price displayed with a strikethrough for the renewal price. Provide
+      #   @param three_ds_level [Symbol, WhopSDK::Models::PlanUpdateParams::ThreeDSLevel] 3D Secure behavior for this plan. Send `null` to inherit the account default.
       #
       #   @param title [String, nil] The display name of the plan shown to customers on the product page.
       #
-      #   @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a recurring plan.
+      #   @param trial_period_days [Integer, nil] Free trial duration before the first recurring charge.
       #
       #   @param unlimited_stock [Boolean, nil] Whether the plan has unlimited stock. When true, the stock field is ignored.
       #
-      #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+      #   @param visibility [String] Whether the plan is visible to customers or hidden from public view.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      class CheckoutStyling < WhopSDK::Internal::Type::BaseModel
-        # @!attribute background_color
-        #   A hex color code for the checkout page background, applied to the order summary
-        #   panel (e.g. #F4F4F5).
-        #
-        #   @return [String, nil]
-        optional :background_color, String, nil?: true
-
-        # @!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).
+      class CustomField < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the custom field (if being updated).
         #
         #   @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(background_color: nil, border_style: nil, button_color: nil, font_family: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::PlanUpdateParams::CheckoutStyling} for more details.
-        #
-        #   Checkout styling overrides for this plan. Pass null to remove all overrides and
-        #   inherit from the company default.
-        #
-        #   @param background_color [String, nil] A hex color code for the checkout page background, applied to the order summary
-        #
-        #   @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
+        optional :id, String
 
-      class CustomField < WhopSDK::Internal::Type::BaseModel
         # @!attribute field_type
         #   The type of the custom field.
         #
-        #   @return [Symbol, :text]
-        required :field_type, const: :text
+        #   @return [Symbol, WhopSDK::Models::PlanUpdateParams::CustomField::FieldType, nil]
+        optional :field_type, enum: -> { WhopSDK::PlanUpdateParams::CustomField::FieldType }
 
         # @!attribute name
         #   The name of the custom field.
         #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute id
-        #   The ID of the custom field (if being updated)
-        #
         #   @return [String, nil]
-        optional :id, String, nil?: true
+        optional :name, String
 
         # @!attribute order
         #   The order of the field.
         #
         #   @return [Integer, nil]
-        optional :order, Integer, nil?: true
+        optional :order, Integer
 
         # @!attribute placeholder
-        #   The placeholder value of the field.
+        #   An example response displayed in the input field.
         #
         #   @return [String, nil]
         optional :placeholder, String, nil?: true
@@ -287,73 +257,86 @@ module WhopSDK
         #   Whether or not the field is required.
         #
         #   @return [Boolean, nil]
-        optional :required, WhopSDK::Internal::Type::Boolean, nil?: true
+        optional :required, WhopSDK::Internal::Type::Boolean
 
-        # @!method initialize(name:, id: nil, order: nil, placeholder: nil, required: nil, field_type: :text)
-        #   @param name [String] The name of the custom field.
+        # @!method initialize(id: nil, field_type: nil, name: nil, order: nil, placeholder: nil, required: nil)
+        #   @param id [String] The ID of the custom field (if being updated).
+        #
+        #   @param field_type [Symbol, WhopSDK::Models::PlanUpdateParams::CustomField::FieldType] The type of the custom field.
         #
-        #   @param id [String, nil] The ID of the custom field (if being updated)
+        #   @param name [String] The name of the custom field.
         #
-        #   @param order [Integer, nil] The order of the field.
+        #   @param order [Integer] The order of the field.
         #
-        #   @param placeholder [String, nil] The placeholder value of the field.
+        #   @param placeholder [String, nil] An example response displayed in the input field.
         #
-        #   @param required [Boolean, nil] Whether or not the field is required.
+        #   @param required [Boolean] Whether or not the field is required.
+
+        # The type of the custom field.
         #
-        #   @param field_type [Symbol, :text] The type of the custom field.
+        # @see WhopSDK::Models::PlanUpdateParams::CustomField#field_type
+        module FieldType
+          extend WhopSDK::Internal::Type::Enum
+
+          TEXT = :text
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       class Image < WhopSDK::Internal::Type::BaseModel
         # @!attribute id
-        #   The ID of an existing file object.
         #
-        #   @return [String]
-        required :id, String
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute direct_upload_id
+        #
+        #   @return [String, nil]
+        optional :direct_upload_id, String
 
-        # @!method initialize(id:)
+        # @!method initialize(id: nil, direct_upload_id: nil)
         #   An image displayed on the product page to represent this plan.
         #
-        #   @param id [String] The ID of an existing file object.
+        #   @param id [String]
+        #   @param direct_upload_id [String]
       end
 
       class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
         # @!attribute disabled
-        #   An array of payment method identifiers that are explicitly disabled. Only
-        #   applies if the include_platform_defaults is true.
         #
-        #   @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
-        required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
+        #   @return [Array<String>, nil]
+        optional :disabled, WhopSDK::Internal::Type::ArrayOf[String]
 
         # @!attribute enabled
-        #   An array of payment method identifiers that are explicitly enabled. This means
-        #   these payment methods will be shown on checkout. Example use case is to only
-        #   enable a specific payment method like cashapp, or extending the platform
-        #   defaults with additional methods.
         #
-        #   @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
-        required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
+        #   @return [Array<String>, nil]
+        optional :enabled, WhopSDK::Internal::Type::ArrayOf[String]
 
         # @!attribute include_platform_defaults
-        #   Whether Whop's platform default payment method enablement settings are included
-        #   in this configuration. The full list of default payment methods can be found in
-        #   the documentation at docs.whop.com/payments.
         #
         #   @return [Boolean, nil]
-        optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
+        optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean
 
-        # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration} for more
-        #   details.
-        #
-        #   Explicit payment method configuration for the plan. Sending null removes any
-        #   custom configuration.
-        #
-        #   @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
+        # @!method initialize(disabled: nil, enabled: nil, include_platform_defaults: nil)
+        #   Explicit payment method configuration for the plan. When not provided, the
+        #   account's defaults apply.
         #
-        #   @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
-        #
-        #   @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
+        #   @param disabled [Array<String>]
+        #   @param enabled [Array<String>]
+        #   @param include_platform_defaults [Boolean]
+      end
+
+      # 3D Secure behavior for this plan. Send `null` to inherit the account default.
+      module ThreeDSLevel
+        extend WhopSDK::Internal::Type::Enum
+
+        MANDATE_CHALLENGE = :mandate_challenge
+        FRICTIONLESS = :frictionless
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/whop_sdk/models/product.rb

@@ -22,8 +22,7 @@ module WhopSDK
       required :created_at, Time
 
       # @!attribute custom_cta
-      #   The call-to-action button label displayed on the product's purchase page (e.g.,
-      #   'join', 'buy', 'subscribe').
+      #   Call-to-action button label shown on the product purchase page.
       #
       #   @return [Symbol, WhopSDK::Models::CustomCta]
       required :custom_cta, enum: -> { WhopSDK::CustomCta }
@@ -36,9 +35,8 @@ module WhopSDK
       required :custom_cta_url, String, nil?: true
 
       # @!attribute custom_statement_descriptor
-      #   A custom text label that appears on the customer's bank or credit card statement
-      #   for purchases of this product. Maximum 22 characters, including the required
-      #   prefix WHOP\*.
+      #   Custom bank statement descriptor for product purchases. Maximum 22 characters,
+      #   including required `WHOP*` prefix.
       #
       #   @return [String, nil]
       required :custom_statement_descriptor, String, nil?: true
@@ -51,9 +49,8 @@ module WhopSDK
       required :description, String, nil?: true
 
       # @!attribute external_identifier
-      #   A unique identifier used to create or update products via the API. When provided
-      #   on product creation endpoints, an existing product with this identifier will be
-      #   updated instead of creating a new one.
+      #   External identifier for the product. Providing it on a product creation endpoint
+      #   updates the existing product with this identifier instead of creating a new one.
       #
       #   @return [String, nil]
       required :external_identifier, String, nil?: true
@@ -65,8 +62,8 @@ module WhopSDK
       required :gallery_images, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Product::GalleryImage] }
 
       # @!attribute global_affiliate_percentage
-      #   The commission rate (as a percentage) that affiliates earn on sales through the
-      #   Whop marketplace global affiliate program. Null if the program is not active.
+      #   Marketplace affiliate commission percentage for this product, or `null` if
+      #   program is inactive.
       #
       #   @return [Float, nil]
       required :global_affiliate_percentage, Float, nil?: true
@@ -85,9 +82,8 @@ module WhopSDK
       required :headline, String, nil?: true
 
       # @!attribute member_affiliate_percentage
-      #   The commission rate (as a percentage) that existing members earn when referring
-      #   new customers through the member affiliate program. Null if the program is not
-      #   active.
+      #   Member referral commission percentage for this product, or `null` if program is
+      #   inactive.
       #
       #   @return [Float, nil]
       required :member_affiliate_percentage, Float, nil?: true
@@ -99,12 +95,20 @@ module WhopSDK
       required :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }
 
       # @!attribute member_count
-      #   The number of users who currently hold an active membership to this product.
-      #   Returns 0 if the company has disabled public member counts.
+      #   Active memberships for this product. Returns `0` if the account has disabled
+      #   public member counts.
       #
       #   @return [Integer]
       required :member_count, Integer
 
+      # @!attribute metadata
+      #   Custom key-value pairs stored on the product and included in payment and
+      #   membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters
+      #   per string value.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute owner_user
       #   The user who owns the company that sells this product.
       #
@@ -125,8 +129,8 @@ module WhopSDK
       required :published_reviews_count, Integer
 
       # @!attribute route
-      #   The URL slug used in the product's public link (e.g., 'my-product' in
-      #   whop.com/company/my-product).
+      #   URL slug in the product's public link, e.g. `pickaxe-analytics` in
+      #   whop.com/company/pickaxe-analytics.
       #
       #   @return [String]
       required :route, String
@@ -157,7 +161,7 @@ module WhopSDK
       #   @return [Symbol, WhopSDK::Models::Visibility]
       required :visibility, enum: -> { WhopSDK::Visibility }
 
-      # @!method initialize(id:, company:, created_at:, custom_cta:, custom_cta_url:, custom_statement_descriptor:, description:, external_identifier:, gallery_images:, global_affiliate_percentage:, global_affiliate_status:, headline:, member_affiliate_percentage:, member_affiliate_status:, member_count:, owner_user:, product_tax_code:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
+      # @!method initialize(id:, company:, created_at:, custom_cta:, custom_cta_url:, custom_statement_descriptor:, description:, external_identifier:, gallery_images:, global_affiliate_percentage:, global_affiliate_status:, headline:, member_affiliate_percentage:, member_affiliate_status:, member_count:, metadata:, owner_user:, product_tax_code:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
       #   Some parameter documentations has been truncated, see {WhopSDK::Models::Product}
       #   for more details.
       #
@@ -170,29 +174,31 @@ module WhopSDK
       #
       #   @param created_at [Time] The datetime the product was created.
       #
-      #   @param custom_cta [Symbol, WhopSDK::Models::CustomCta] The call-to-action button label displayed on the product's purchase page (e.g.,
+      #   @param custom_cta [Symbol, WhopSDK::Models::CustomCta] Call-to-action button label shown on the product purchase page.
       #
       #   @param custom_cta_url [String, nil] An optional URL that the call-to-action button links to instead of the default c
       #
-      #   @param custom_statement_descriptor [String, nil] A custom text label that appears on the customer's bank or credit card statement
+      #   @param custom_statement_descriptor [String, nil] Custom bank statement descriptor for product purchases. Maximum 22 characters, i
       #
       #   @param description [String, nil] A brief summary of what the product offers, displayed on product pages and searc
       #
-      #   @param external_identifier [String, nil] A unique identifier used to create or update products via the API. When provided
+      #   @param external_identifier [String, nil] External identifier for the product. Providing it on a product creation endpoint
       #
       #   @param gallery_images [Array<WhopSDK::Models::Product::GalleryImage>] The gallery images for this product, ordered by position.
       #
-      #   @param global_affiliate_percentage [Float, nil] The commission rate (as a percentage) that affiliates earn on sales through the
+      #   @param global_affiliate_percentage [Float, nil] Marketplace affiliate commission percentage for this product, or `null` if progr
       #
       #   @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus] The enrollment status of this product in the Whop marketplace global affiliate p
       #
       #   @param headline [String, nil] A short marketing headline displayed prominently on the product's product page.
       #
-      #   @param member_affiliate_percentage [Float, nil] The commission rate (as a percentage) that existing members earn when referring
+      #   @param member_affiliate_percentage [Float, nil] Member referral commission percentage for this product, or `null` if program is
       #
       #   @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus] The enrollment status of this product in the member affiliate program.
       #
-      #   @param member_count [Integer] The number of users who currently hold an active membership to this product. Ret
+      #   @param member_count [Integer] Active memberships for this product. Returns `0` if the account has disabled pub
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product and included in payment and members
       #
       #   @param owner_user [WhopSDK::Models::Product::OwnerUser] The user who owns the company that sells this product.
       #
@@ -200,7 +206,7 @@ module WhopSDK
       #
       #   @param published_reviews_count [Integer] The total number of published customer reviews for this product's company.
       #
-      #   @param route [String] The URL slug used in the product's public link (e.g., 'my-product' in whop.com/c
+      #   @param route [String] URL slug in the product's public link, e.g. `pickaxe-analytics` in whop.com/comp
       #
       #   @param title [String] The display name of the product shown to customers on the product page and in se
       #
@@ -219,7 +225,7 @@ module WhopSDK
         required :id, String
 
         # @!attribute route
-        #   The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
+        #   URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe.
         #
         #   @return [String]
         required :route, String
@@ -231,14 +237,11 @@ module WhopSDK
         required :title, String
 
         # @!method initialize(id:, route:, title:)
-        #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::Product::Company} for more details.
-        #
         #   The company this product belongs to.
         #
         #   @param id [String] The unique identifier for the company.
         #
-        #   @param route [String] The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
+        #   @param route [String] URL slug for the account's store page, e.g. `pickaxe` in whop.com/pickaxe.
         #
         #   @param title [String] The display name of the company shown to customers.
       end
@@ -311,14 +314,14 @@ module WhopSDK
         required :id, String
 
         # @!attribute name
-        #   The human-readable name of this tax classification (e.g., 'Digital - SaaS').
+        #   Human-readable name of this tax classification, such as 'Digital - SaaS'.
         #
         #   @return [String]
         required :name, String
 
         # @!attribute product_type
-        #   The broad product category this tax code covers (e.g., physical goods, digital
-        #   services).
+        #   Broad product category this tax code covers, such as physical goods or digital
+        #   services.
         #
         #   @return [Symbol, WhopSDK::Models::Product::ProductTaxCode::ProductType]
         required :product_type, enum: -> { WhopSDK::Product::ProductTaxCode::ProductType }
@@ -332,12 +335,12 @@ module WhopSDK
         #
         #   @param id [String] The unique identifier for the product tax code.
         #
-        #   @param name [String] The human-readable name of this tax classification (e.g., 'Digital - SaaS').
+        #   @param name [String] Human-readable name of this tax classification, such as 'Digital - SaaS'.
         #
-        #   @param product_type [Symbol, WhopSDK::Models::Product::ProductTaxCode::ProductType] The broad product category this tax code covers (e.g., physical goods, digital s
+        #   @param product_type [Symbol, WhopSDK::Models::Product::ProductTaxCode::ProductType] Broad product category this tax code covers, such as physical goods or digital s
 
-        # The broad product category this tax code covers (e.g., physical goods, digital
-        # services).
+        # Broad product category this tax code covers, such as physical goods or digital
+        # services.
         #
         # @see WhopSDK::Models::Product::ProductTaxCode#product_type
         module ProductType