Skip to main content
PATCH
/
products
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: 'My API Key',
});

const product = await client.products.update('prod_xxxxxxxxxxxxx');

console.log(product.id);
{
  "id": "prod_xxxxxxxxxxxxx",
  "title": "<string>",
  "visibility": "visible",
  "headline": "<string>",
  "verified": true,
  "business_type": "education_program",
  "industry_type": "trading",
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "member_count": 42,
  "route": "<string>",
  "published_reviews_count": 42,
  "external_identifier": "<string>",
  "description": "<string>",
  "custom_cta": "get_access",
  "custom_cta_url": "<string>",
  "custom_statement_descriptor": "<string>",
  "global_affiliate_percentage": 6.9,
  "global_affiliate_status": "enabled",
  "member_affiliate_percentage": 6.9,
  "member_affiliate_status": "enabled",
  "product_tax_code": {
    "id": "ptc_xxxxxxxxxxxxxx",
    "name": "<string>",
    "product_type": "physical"
  },
  "owner_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "<string>",
    "username": "<string>"
  },
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "<string>",
    "title": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

​
id
string
required

The ID (tag) of the product

Example:

"prod_xxxxxxxxxxxxx"

Body

application/json

Parameters for UpdateAccessPass

​
banner_image
object | null

A banner image for the product in png, jpeg format Input for an attachment

  • AttachmentInputWithDirectUploadId
  • AttachmentInputWithId
​
business_type
enum<string> | null

The business type of the product. The different business types a company can be.

Available options:
education_program,
coaching,
software,
paid_group,
newsletter,
agency,
physical_products,
brick_and_mortar,
events,
coaching_and_courses,
other,
saas,
course,
community
​
collect_shipping_address
boolean | null

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

​
custom_cta
enum<string> | null

The custom call to action for the product. The different types of custom CTAs that can be selected.

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

The custom call to action URL for the product.

​
custom_statement_descriptor
string | null

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: <, >, , ', "

​
description
string | null

A written description of the product.

​
global_affiliate_percentage
number | null

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

Example:

6.9

​
global_affiliate_status
enum<string> | null

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

Available options:
enabled,
disabled
​
headline
string | null

The headline of the product.

​
industry_type
enum<string> | null

The industry type of the product. The different industry types a company can be in.

Available options:
trading,
sports_betting,
reselling,
fitness,
amazon_fba,
real_estate,
kindle_book_publishing,
dating,
agencies,
health_and_wellness,
social_media,
sales,
business,
ecommerce,
video_games,
home_services,
ai,
public_speaking,
personal_finance,
careers,
travel,
clipping,
spirituality,
vas,
personal_development,
software,
other,
marketing_agency,
sales_agency,
ai_agency,
design_agency,
coaching_agency,
development_agency,
recruiting_agency,
customer_support_agency,
clipping_agency,
clothing,
supplements,
beauty_and_personal_care,
fitness_gear,
accessories,
home_goods,
electronics_and_gadgets,
food_and_beverages,
gym,
restaurant,
retail_store,
coffee_shop,
salon_spa,
medical_dentist_office,
hotel_lodging,
auto_repair_shop,
masterminds,
webinars,
bootcamps,
convention,
concerts,
meetups,
parties
​
member_affiliate_percentage
number | null

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

Example:

6.9

​
member_affiliate_status
enum<string> | null

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

Available options:
enabled,
disabled
​
product_tax_code_id
string | null

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

Example:

"ptc_xxxxxxxxxxxxxx"

​
redirect_purchase_url
string | null

The URL to redirect the customer to after a purchase.

​
route
string | null

The route of the product.

​
store_page_config
object | null

Configuration for a product on the company's store page.

​
title
string | null

The title of the product.

​
visibility
enum<string> | null

This product will/will not be displayed publicly. Visibility of a resource

Available options:
visible,
hidden,
archived,
quick_link

Response

A successful response

Represents a product on whop. Use products to sell anything on the platform.

​
id
string
required

The internal ID of the public product.

Example:

"prod_xxxxxxxxxxxxx"

​
title
string
required

The title of the product. Use for Whop 4.0.

​
visibility
enum<string>
required

This product will/will not be displayed publicly.

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

The headline of the product.

​
verified
boolean
required

Whether this product is Whop verified.

​
business_type
enum<string> | null
required

The type of business the company is. The different business types a company can be.

Available options:
education_program,
coaching,
software,
paid_group,
newsletter,
agency,
physical_products,
brick_and_mortar,
events,
coaching_and_courses,
other,
saas,
course,
community
​
industry_type
enum<string> | null
required

The specific industry the company operates in. The different industry types a company can be in.

Available options:
trading,
sports_betting,
reselling,
fitness,
amazon_fba,
real_estate,
kindle_book_publishing,
dating,
agencies,
health_and_wellness,
social_media,
sales,
business,
ecommerce,
video_games,
home_services,
ai,
public_speaking,
personal_finance,
careers,
travel,
clipping,
spirituality,
vas,
personal_development,
software,
other,
marketing_agency,
sales_agency,
ai_agency,
design_agency,
coaching_agency,
development_agency,
recruiting_agency,
customer_support_agency,
clipping_agency,
clothing,
supplements,
beauty_and_personal_care,
fitness_gear,
accessories,
home_goods,
electronics_and_gadgets,
food_and_beverages,
gym,
restaurant,
retail_store,
coffee_shop,
salon_spa,
medical_dentist_office,
hotel_lodging,
auto_repair_shop,
masterminds,
webinars,
bootcamps,
convention,
concerts,
meetups,
parties
​
created_at
string<date-time>
required

When the product was created.

Example:

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

​
updated_at
string<date-time>
required

When the product was updated.

Example:

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

​
member_count
integer
required

The number of active users for this product.

Example:

42

​
route
string
required

The route of the product.

​
published_reviews_count
integer
required

The number of reviews that have been published for the product.

Example:

42

​
external_identifier
string | null
required

A unique identifier used to create or update products. When provided on product creation endpoints, we’ll look up an existing product by this identifier — if it exists, we’ll update it; if not, we’ll create a new one.

​
description
string | null
required

A short description of what the company offers or does.

​
custom_cta
enum<string>
required

The custom call to action for the product.

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

The custom call to action URL for the product, if any.

​
custom_statement_descriptor
string | null
required

The custom statement descriptor for the product.

​
global_affiliate_percentage
number | null
required

The percentage of a transaction a user is eligible to earn from the whop marketplace global affiliate program.

Example:

6.9

​
global_affiliate_status
enum<string>
required

The status of the global affiliate program for this product.

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

The percentage of a transaction a user is eligible to earn from the whop marketplace member affiliate program.

Example:

6.9

​
member_affiliate_status
enum<string>
required

The status of the member affiliate program for this product.

Available options:
enabled,
disabled
​
product_tax_code
object | null
required

The product tax code for the product, if any.

​
owner_user
object
required

The user that owns the product (company owner).

​
company
object
required

A short type of the company that this product belongs to.