For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word ‘Bearer’, which will look like Bearer ***************************
Path parameters
idstringRequired
The unique identifier or route slug of the product.
Response
A successful response
companyobject
The company this product belongs to.
created_atdatetime
The datetime the product was created.
custom_ctaenum
The call-to-action button label displayed on the product’s purchase page (e.g., ‘join’, ‘buy’, ‘subscribe’).
custom_cta_urlstring or null
An optional URL that the call-to-action button links to instead of the default checkout flow. Null if no custom URL is set.
custom_statement_descriptorstring or null
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*.
descriptionstring or null
A brief summary of what the product offers, displayed on product pages and search results.
external_identifierstring or null
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.
gallery_imageslist of objects
The gallery images for this product, ordered by position.
global_affiliate_percentagedouble or null
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.
global_affiliate_statusenum
The enrollment status of this product in the Whop marketplace global affiliate program.
Allowed values:
headlinestring or null
A short marketing headline displayed prominently on the product's product page.
idstring
The unique identifier for the product.
member_affiliate_percentagedouble or null
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_affiliate_statusenum
The enrollment status of this product in the member affiliate program.
Allowed values:
member_countinteger
The number of users who currently hold an active membership to this product. Returns 0 if the company has disabled public member counts.
metadatamap from strings to any or null
Custom key-value pairs stored on the product. Included in webhook payloads for payment and membership events.
owner_userobject
The user who owns the company that sells this product.
product_tax_codeobject or null
The tax classification code applied to purchases of this product for sales tax calculation. Null if no tax code is assigned.
published_reviews_countinteger
The total number of published customer reviews for this product's company.
routestring
The URL slug used in the product’s public link (e.g., ‘my-product’ in whop.com/company/my-product).
titlestring
The display name of the product shown to customers on the product page and in search results.
updated_atdatetime
The datetime the product was last updated.
verifiedboolean
Whether this company has been verified by Whop's trust and safety team.
visibilityenum
Controls whether the product is visible to customers. When set to 'hidden', the product is only accessible via direct link.
