Retrieve product
Retrieves the details of an existing product.
Required permissions:
access_pass:basic:read
Authorizations
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
The unique identifier or route slug of the product.
"prod_xxxxxxxxxxxxx"
Response
A successful response
A product is a digital good or service sold on Whop. Products contain plans for pricing and experiences for content delivery.
The company this product belongs to.
The datetime the product was created.
"2023-12-01T05:00:00.401Z"
Call-to-action button label shown on the product purchase page.
get_access, join, order_now, shop_now, call_now, donate_now, contact_us, sign_up, subscribe, purchase, get_offer, apply_now, complete_order An optional URL that the call-to-action button links to instead of the default checkout flow. Null if no custom URL is set.
"https://example.com/signup"
Custom bank statement descriptor for product purchases. Maximum 22 characters, including required WHOP* prefix.
"PICKAXE"
A brief summary of what the product offers, displayed on product pages and search results.
"Track your revenue, members, and growth in real time."
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.
"ext_prod_12345"
The gallery images for this product, ordered by position.
Marketplace affiliate commission percentage for this product, or null if program is inactive.
6.9
The enrollment status of this product in the Whop marketplace global affiliate program.
enabled, disabled A short marketing headline displayed prominently on the product's product page.
"Real-time data analytics for creators"
The unique identifier for the product.
"prod_xxxxxxxxxxxxx"
Member referral commission percentage for this product, or null if program is inactive.
6.9
The enrollment status of this product in the member affiliate program.
enabled, disabled Active memberships for this product. Returns 0 if the account has disabled public member counts.
42
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.
The user who owns the company that sells this product.
The tax classification code applied to purchases of this product for sales tax calculation. Null if no tax code is assigned.
The total number of published customer reviews for this product's company.
42
URL slug in the product's public link, e.g. pickaxe-analytics in whop.com/company/pickaxe-analytics.
"pickaxe-analytics"
The display name of the product shown to customers on the product page and in search results.
"Pickaxe Analytics"
The datetime the product was last updated.
"2023-12-01T05:00:00.401Z"
Whether this company has been verified by Whop's trust and safety team.
Controls whether the product is visible to customers. When set to 'hidden', the product is only accessible via direct link.
visible, hidden, archived, quick_link 
