Sign in
Products

Update Product

Updates an existing product.

patch/products/{id}

Request body

descriptionstring nullable

A written description displayed on the product page.

headlinestring nullable

A short marketing headline for the product page.

metadataobject nullable

Custom key-value pairs to store on the product.

product_tax_code_idstring nullable

The unique identifier of the tax classification code. See the available product categories.

send_welcome_messageboolean nullable

Whether to send an automated welcome message via support chat when a user joins this product.

titlestring

The display name of the product.

visibilitystring

Whether the product is visible to customers.

Response

product tax code updated

created_atstring date-time required

The datetime the product was created.

custom_cta'get_access' | 'join' | 'order_now' | 'shop_now' | 'call_now' | 'donate_now' | 'contact_us' | 'sign_up' | 'subscribe' | 'purchase' | 'get_offer' | 'apply_now' | 'complete_order' required

The different types of custom CTAs that can be selected.

custom_cta_urlstring nullable 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.

custom_statement_descriptorstring nullable required

Custom bank statement descriptor for product purchases. Maximum 22 characters, including required WHOP* prefix.

descriptionstring nullable required

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

external_identifierstring nullable required

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.

global_affiliate_percentagenumber nullable required

Marketplace affiliate commission percentage for this product, or null if program is inactive.

global_affiliate_status'enabled' | 'disabled' required

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

headlinestring nullable required

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

idstring required

The unique identifier for the product.

member_affiliate_percentagenumber nullable required

Member referral commission percentage for this product, or null if program is inactive.

member_affiliate_status'enabled' | 'disabled' required

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

member_countinteger required

Active memberships for this product. Returns 0 if the account has disabled public member counts.

metadataobject nullable required

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.

published_reviews_countinteger required

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

routestring required

URL slug in the product's public link, e.g. pickaxe-analytics in whop.com/company/pickaxe-analytics.

titlestring required

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

updated_atstring date-time required

The datetime the product was last updated.

verifiedboolean required

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

visibility'visible' | 'hidden' | 'archived' | 'quick_link' required

Visibility of a resource

Example response

{
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "pickaxe",
    "title": "Pickaxe"
  },
  "created_at": "2023-12-01T05:00:00.401Z",
  "custom_cta_url": "https://example.com/signup",
  "custom_statement_descriptor": "PICKAXE",
  "description": "Track your revenue, members, and growth in real time.",
  "external_identifier": "ext_prod_12345",
  "gallery_images": [
    {
      "url": "https://media.whop.com/abc123/optimized.jpg"
    }
  ],
  "global_affiliate_percentage": 6.9,
  "headline": "Real-time data analytics for creators",
  "id": "prod_xxxxxxxxxxxxx",
  "member_affiliate_percentage": 6.9,
  "member_count": 42,
  "owner_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "product_tax_code": {
    "id": "ptc_xxxxxxxxxxxxxx",
    "name": "Digital - SaaS"
  },
  "published_reviews_count": 42,
  "route": "pickaxe-analytics",
  "title": "Pickaxe Analytics",
  "updated_at": "2023-12-01T05:00:00.401Z"
}

Changes