Skip to main content

A product is a digital good or service sold on Whop. Products contain plans for pricing and experiences for content delivery.

​
id
string
required

The unique identifier for the product.

Example:

"prod_xxxxxxxxxxxxx"

​
title
string
required

The display name of the product shown to customers on the product page and in search results.

Example:

"Pickaxe Analytics"

​
visibility
enum<string>
required

Controls whether the product is visible to customers. When set to 'hidden', the product is only accessible via direct link.

Available options:
visible,
hidden,
archived,
quick_link
​
headline
string | null
required

A short marketing headline displayed prominently on the product's product page.

Example:

"Real-time data analytics for creators"

​
verified
boolean
required

Whether this company has been verified by Whop's trust and safety team.

​
created_at
string<date-time>
required

The datetime the product was created.

Example:

"2023-12-01T05:00:00.401Z"

​
updated_at
string<date-time>
required

The datetime the product was last updated.

Example:

"2023-12-01T05:00:00.401Z"

​
member_count
integer
required

The number of users who currently hold an active membership to this product. Returns 0 if the company has disabled public member counts.

Example:

42

​
route
string
required

The URL slug used in the product's public link (e.g., 'my-product' in whop.com/company/my-product).

Example:

"pickaxe-analytics"

​
published_reviews_count
integer
required

The total number of published customer reviews for this product's company.

Example:

42

​
external_identifier
string | null
required

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.

Example:

"ext_prod_12345"

​
description
string | null
required

A brief summary of what the product offers, displayed on product pages and search results.

Example:

"Track your revenue, members, and growth in real time."

​
custom_cta
enum<string>
required

The call-to-action button label displayed on the product's purchase page (e.g., 'join', 'buy', 'subscribe').

Available options:
get_access,
join,
order_now,
shop_now,
call_now,
donate_now,
contact_us,
sign_up,
subscribe,
purchase,
get_offer,
apply_now,
complete_order
​
custom_cta_url
string | null
required

An optional URL that the call-to-action button links to instead of the default checkout flow. Null if no custom URL is set.

Example:

"https://example.com/signup"

​
custom_statement_descriptor
string | null
required

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*.

Example:

"PICKAXE"

​
global_affiliate_percentage
number | null
required

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.

Example:

6.9

​
global_affiliate_status
enum<string>
required

The enrollment status of this product in the Whop marketplace global affiliate program.

Available options:
enabled,
disabled
​
member_affiliate_percentage
number | null
required

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.

Example:

6.9

​
member_affiliate_status
enum<string>
required

The enrollment status of this product in the member affiliate program.

Available options:
enabled,
disabled
​
gallery_images
object[]
required

The gallery images for this product, ordered by position.

​
product_tax_code
object
required

The tax classification code applied to purchases of this product for sales tax calculation. Null if no tax code is assigned.

​
owner_user
object
required

The user who owns the company that sells this product.

​
company
object
required

The company this product belongs to.