Update Product

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.products.update({
    id: "id"
});

curl --request PATCH \
  --url https://api.whop.com/api/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "banner_image": {
    "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "id": "file_xxxxxxxxxxxxxx"
  },
  "description": "Full interior extraction, leather conditioning, and an ozone odor treatment.",
  "gallery_images": [
    {
      "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "id": "file_xxxxxxxxxxxxxx"
    }
  ],
  "headline": "Steam, shampoo, and odor removal in one visit",
  "labels": [
    "<string>"
  ],
  "metadata": {
    "bay": "1",
    "duration_hours": "4"
  },
  "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
  "send_welcome_message": true,
  "title": "Interior Deep Clean",
  "visibility": "visible"
}
'

import requests

url = "https://api.whop.com/api/v1/products/{id}"

payload = {
    "banner_image": {
        "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "id": "file_xxxxxxxxxxxxxx"
    },
    "description": "Full interior extraction, leather conditioning, and an ozone odor treatment.",
    "gallery_images": [
        {
            "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "id": "file_xxxxxxxxxxxxxx"
        }
    ],
    "headline": "Steam, shampoo, and odor removal in one visit",
    "labels": ["<string>"],
    "metadata": {
        "bay": "1",
        "duration_hours": "4"
    },
    "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
    "send_welcome_message": True,
    "title": "Interior Deep Clean",
    "visibility": "visible"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    banner_image: {
      direct_upload_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
      id: 'file_xxxxxxxxxxxxxx'
    },
    description: 'Full interior extraction, leather conditioning, and an ozone odor treatment.',
    gallery_images: [
      {
        direct_upload_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        id: 'file_xxxxxxxxxxxxxx'
      }
    ],
    headline: 'Steam, shampoo, and odor removal in one visit',
    labels: ['<string>'],
    metadata: {bay: '1', duration_hours: '4'},
    product_tax_code_id: 'ptc_xxxxxxxxxxxxxx',
    send_welcome_message: true,
    title: 'Interior Deep Clean',
    visibility: 'visible'
  })
};

fetch('https://api.whop.com/api/v1/products/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/products/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'banner_image' => [
        'direct_upload_id' => 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        'id' => 'file_xxxxxxxxxxxxxx'
    ],
    'description' => 'Full interior extraction, leather conditioning, and an ozone odor treatment.',
    'gallery_images' => [
        [
                'direct_upload_id' => 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
                'id' => 'file_xxxxxxxxxxxxxx'
        ]
    ],
    'headline' => 'Steam, shampoo, and odor removal in one visit',
    'labels' => [
        '<string>'
    ],
    'metadata' => [
        'bay' => '1',
        'duration_hours' => '4'
    ],
    'product_tax_code_id' => 'ptc_xxxxxxxxxxxxxx',
    'send_welcome_message' => true,
    'title' => 'Interior Deep Clean',
    'visibility' => 'visible'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/products/{id}"

	payload := strings.NewReader("{\n  \"banner_image\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"description\": \"Full interior extraction, leather conditioning, and an ozone odor treatment.\",\n  \"gallery_images\": [\n    {\n      \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"headline\": \"Steam, shampoo, and odor removal in one visit\",\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"bay\": \"1\",\n    \"duration_hours\": \"4\"\n  },\n  \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n  \"send_welcome_message\": true,\n  \"title\": \"Interior Deep Clean\",\n  \"visibility\": \"visible\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/products/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"banner_image\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"description\": \"Full interior extraction, leather conditioning, and an ozone odor treatment.\",\n  \"gallery_images\": [\n    {\n      \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"headline\": \"Steam, shampoo, and odor removal in one visit\",\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"bay\": \"1\",\n    \"duration_hours\": \"4\"\n  },\n  \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n  \"send_welcome_message\": true,\n  \"title\": \"Interior Deep Clean\",\n  \"visibility\": \"visible\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/products/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"banner_image\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"description\": \"Full interior extraction, leather conditioning, and an ozone odor treatment.\",\n  \"gallery_images\": [\n    {\n      \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"headline\": \"Steam, shampoo, and odor removal in one visit\",\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"bay\": \"1\",\n    \"duration_hours\": \"4\"\n  },\n  \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n  \"send_welcome_message\": true,\n  \"title\": \"Interior Deep Clean\",\n  \"visibility\": \"visible\"\n}"

response = http.request(request)
puts response.read_body

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "average_review_rating": 0,
  "created_at": "2026-01-01T12:00:00.000Z",
  "custom_cta": "order_now",
  "custom_cta_url": "https://shinetime.example/book",
  "custom_statement_descriptor": "WHOP*SHINETIME",
  "default_plan": {
    "billing_period": 30,
    "expiration_days": 123,
    "id": "plan_xxxxxxxxxxxxxx",
    "initial_price": {
      "amount": "-2.50",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "plan_type": "renewal",
    "renewal_price": {
      "amount": "-2.50",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "title": "<string>",
    "unlimited_stock": true,
    "visibility": "visible"
  },
  "description": "Full interior extraction, leather conditioning, and an ozone odor treatment.",
  "external_identifier": "SHINE-CERAMIC-01",
  "gallery_images": [
    {
      "content_type": "image/png",
      "id": "file_xxxxxxxxxxxxxx",
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ],
  "global_affiliate_percentage": 10,
  "global_affiliate_status": "enabled",
  "headline": "Steam, shampoo, and odor removal in one visit",
  "id": "prod_xxxxxxxxxxxxxx",
  "labels": [
    "interior"
  ],
  "marketplace_status": "not_available",
  "member_affiliate_percentage": 5,
  "member_affiliate_status": "enabled",
  "member_count": 0,
  "metadata": {
    "bay": "1",
    "duration_hours": "4"
  },
  "owner_user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Marcus Webb",
    "username": "marcuswebb"
  },
  "product_tax_code": {
    "id": "ptc_xxxxxxxxxxxxxx",
    "name": "General - Digital Goods",
    "product_type": "digital"
  },
  "published_reviews_count": 0,
  "route": "interior-deep-clean",
  "title": "Interior Deep Clean",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "verified": false,
  "visibility": "visible"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

PATCH

products

{id}

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.products.update({
    id: "id"
});

curl --request PATCH \
  --url https://api.whop.com/api/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "banner_image": {
    "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "id": "file_xxxxxxxxxxxxxx"
  },
  "description": "Full interior extraction, leather conditioning, and an ozone odor treatment.",
  "gallery_images": [
    {
      "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "id": "file_xxxxxxxxxxxxxx"
    }
  ],
  "headline": "Steam, shampoo, and odor removal in one visit",
  "labels": [
    "<string>"
  ],
  "metadata": {
    "bay": "1",
    "duration_hours": "4"
  },
  "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
  "send_welcome_message": true,
  "title": "Interior Deep Clean",
  "visibility": "visible"
}
'

import requests

url = "https://api.whop.com/api/v1/products/{id}"

payload = {
    "banner_image": {
        "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "id": "file_xxxxxxxxxxxxxx"
    },
    "description": "Full interior extraction, leather conditioning, and an ozone odor treatment.",
    "gallery_images": [
        {
            "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "id": "file_xxxxxxxxxxxxxx"
        }
    ],
    "headline": "Steam, shampoo, and odor removal in one visit",
    "labels": ["<string>"],
    "metadata": {
        "bay": "1",
        "duration_hours": "4"
    },
    "product_tax_code_id": "ptc_xxxxxxxxxxxxxx",
    "send_welcome_message": True,
    "title": "Interior Deep Clean",
    "visibility": "visible"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    banner_image: {
      direct_upload_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
      id: 'file_xxxxxxxxxxxxxx'
    },
    description: 'Full interior extraction, leather conditioning, and an ozone odor treatment.',
    gallery_images: [
      {
        direct_upload_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        id: 'file_xxxxxxxxxxxxxx'
      }
    ],
    headline: 'Steam, shampoo, and odor removal in one visit',
    labels: ['<string>'],
    metadata: {bay: '1', duration_hours: '4'},
    product_tax_code_id: 'ptc_xxxxxxxxxxxxxx',
    send_welcome_message: true,
    title: 'Interior Deep Clean',
    visibility: 'visible'
  })
};

fetch('https://api.whop.com/api/v1/products/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/products/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'banner_image' => [
        'direct_upload_id' => 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        'id' => 'file_xxxxxxxxxxxxxx'
    ],
    'description' => 'Full interior extraction, leather conditioning, and an ozone odor treatment.',
    'gallery_images' => [
        [
                'direct_upload_id' => 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
                'id' => 'file_xxxxxxxxxxxxxx'
        ]
    ],
    'headline' => 'Steam, shampoo, and odor removal in one visit',
    'labels' => [
        '<string>'
    ],
    'metadata' => [
        'bay' => '1',
        'duration_hours' => '4'
    ],
    'product_tax_code_id' => 'ptc_xxxxxxxxxxxxxx',
    'send_welcome_message' => true,
    'title' => 'Interior Deep Clean',
    'visibility' => 'visible'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/products/{id}"

	payload := strings.NewReader("{\n  \"banner_image\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"description\": \"Full interior extraction, leather conditioning, and an ozone odor treatment.\",\n  \"gallery_images\": [\n    {\n      \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"headline\": \"Steam, shampoo, and odor removal in one visit\",\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"bay\": \"1\",\n    \"duration_hours\": \"4\"\n  },\n  \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n  \"send_welcome_message\": true,\n  \"title\": \"Interior Deep Clean\",\n  \"visibility\": \"visible\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/products/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"banner_image\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"description\": \"Full interior extraction, leather conditioning, and an ozone odor treatment.\",\n  \"gallery_images\": [\n    {\n      \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"headline\": \"Steam, shampoo, and odor removal in one visit\",\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"bay\": \"1\",\n    \"duration_hours\": \"4\"\n  },\n  \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n  \"send_welcome_message\": true,\n  \"title\": \"Interior Deep Clean\",\n  \"visibility\": \"visible\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/products/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"banner_image\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"description\": \"Full interior extraction, leather conditioning, and an ozone odor treatment.\",\n  \"gallery_images\": [\n    {\n      \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n      \"id\": \"file_xxxxxxxxxxxxxx\"\n    }\n  ],\n  \"headline\": \"Steam, shampoo, and odor removal in one visit\",\n  \"labels\": [\n    \"<string>\"\n  ],\n  \"metadata\": {\n    \"bay\": \"1\",\n    \"duration_hours\": \"4\"\n  },\n  \"product_tax_code_id\": \"ptc_xxxxxxxxxxxxxx\",\n  \"send_welcome_message\": true,\n  \"title\": \"Interior Deep Clean\",\n  \"visibility\": \"visible\"\n}"

response = http.request(request)
puts response.read_body

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "average_review_rating": 0,
  "created_at": "2026-01-01T12:00:00.000Z",
  "custom_cta": "order_now",
  "custom_cta_url": "https://shinetime.example/book",
  "custom_statement_descriptor": "WHOP*SHINETIME",
  "default_plan": {
    "billing_period": 30,
    "expiration_days": 123,
    "id": "plan_xxxxxxxxxxxxxx",
    "initial_price": {
      "amount": "-2.50",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "plan_type": "renewal",
    "renewal_price": {
      "amount": "-2.50",
      "currency": "usd",
      "decimals": 2,
      "display_decimals": 2
    },
    "title": "<string>",
    "unlimited_stock": true,
    "visibility": "visible"
  },
  "description": "Full interior extraction, leather conditioning, and an ozone odor treatment.",
  "external_identifier": "SHINE-CERAMIC-01",
  "gallery_images": [
    {
      "content_type": "image/png",
      "id": "file_xxxxxxxxxxxxxx",
      "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ],
  "global_affiliate_percentage": 10,
  "global_affiliate_status": "enabled",
  "headline": "Steam, shampoo, and odor removal in one visit",
  "id": "prod_xxxxxxxxxxxxxx",
  "labels": [
    "interior"
  ],
  "marketplace_status": "not_available",
  "member_affiliate_percentage": 5,
  "member_affiliate_status": "enabled",
  "member_count": 0,
  "metadata": {
    "bay": "1",
    "duration_hours": "4"
  },
  "owner_user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Marcus Webb",
    "username": "marcuswebb"
  },
  "product_tax_code": {
    "id": "ptc_xxxxxxxxxxxxxx",
    "name": "General - Digital Goods",
    "product_type": "digital"
  },
  "published_reviews_count": 0,
  "route": "interior-deep-clean",
  "title": "Interior Deep Clean",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "verified": false,
  "visibility": "visible"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-09-15"

Path Parameters

string

required

The unique identifier of the product.

Body

application/json

banner_image

object | null

A wide image for the product, shown on the product page and on listing cards. Pass { id } for an existing attachment or { direct_upload_id } for a completed direct upload; null removes it.

Show child attributes

description

string | null

A written description displayed on the product page.

Example:

"Full interior extraction, leather conditioning, and an ozone odor treatment."

gallery_images

object[] | null

Images or videos displayed in the product gallery, in display order. Replaces the existing gallery. Send an empty array to clear it; omit or pass null to leave it unchanged. A banner image does not populate the gallery.

Maximum array length: 8

Show child attributes

headline

string | null

A short marketing headline for the product page.

Example:

"Steam, shampoo, and odor removal in one visit"

labels

string[] | null

Labels used to group products into collections. Replaces the existing labels. Send an empty array to clear them.

metadata

object | null

Custom key-value pairs to store on the product.

Example:

{ "bay": "1", "duration_hours": "4" }

product_tax_code_id

string | null

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

Example:

"ptc_xxxxxxxxxxxxxx"

send_welcome_message

boolean | null

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

Example:

true

title

string

The display name of the product.

Example:

"Interior Deep Clean"

visibility

string

Whether the product is visible to customers.

Example:

"visible"

Response

product tax code updated

account

object | null

required

Account that sells this product.

Example:

{
  "id": "biz_xxxxxxxxxxxxxx",
  "route": "biz_xxxxxxxxxxxxxx",
  "title": "Shine Time Auto Detailing"
}

average_review_rating

number

required

Average star rating across published reviews for this product, from 1.0 to 5.0. Returns 0.0 when no published-review rating is available.

Example:

0

created_at

string

required

When the product was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

custom_cta

enum<string> | null

required

Call-to-action button label shown on the product purchase page.

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,

null

Example:

"order_now"

custom_cta_url

string | null

required

URL the call-to-action button links to instead of checkout.

Example:

"https://shinetime.example/book"

custom_statement_descriptor

string | null

required

Custom text label on customer's bank statement.

Example:

"WHOP*SHINETIME"

default_plan

object | null

required

Buyable plan to show and check out with. The configured default when that plan is buyable, otherwise the first buyable plan in product-page order. null when none is buyable.

Show child attributes

description

string | null

required

Written description displayed on the product page. null if none is set.

Example:

"Full interior extraction, leather conditioning, and an ozone odor treatment."

external_identifier

string | null

required

External identifier stored on the product for your own reference.

Example:

"SHINE-CERAMIC-01"

gallery_images

object[]

required

Show child attributes

global_affiliate_percentage

number | null

required

Commission rate affiliates earn through the global affiliate program.

Example:

10

global_affiliate_status

enum<string> | null

required

Enrollment status in the global affiliate program.

Available options:

enabled,

disabled,

null

Example:

"enabled"

headline

string | null

required

Short marketing headline displayed on product page.

Example:

"Steam, shampoo, and odor removal in one visit"

string

required

Product ID, prefixed prod_.

Example:

"prod_xxxxxxxxxxxxxx"

labels

string[]

required

Lowercased labels used to group products into collections. Filter the list endpoint by labels to fetch one collection.

marketplace_status

enum<string>

required

Listing state on the whop.com marketplace. pending_review means submitted and awaiting review; live_marketplace means approved and discoverable.

Available options:

not_available,

pending_review,

live_marketplace

Example:

"not_available"

member_affiliate_percentage

number | null

required

Commission rate members earn through the member affiliate program.

Example:

5

member_affiliate_status

enum<string> | null

required

Enrollment status in the member affiliate program.

Available options:

enabled,

disabled,

null

Example:

"enabled"

member_count

number

required

Active memberships for this product; 0 if public member counts are disabled.

Example:

0

metadata

object | null

required

Custom key-value pairs stored on the product.

Example:

{ "bay": "1", "duration_hours": "4" }

owner_user

object | null

required

User who owns the account selling this product.

Example:

{
  "id": "user_xxxxxxxxxxxxxx",
  "name": "Marcus Webb",
  "username": "marcuswebb"
}

product_tax_code

object | null

required

Tax classification code for this product, or null if no tax code is set.

Example:

{
  "id": "ptc_xxxxxxxxxxxxxx",
  "name": "General - Digital Goods",
  "product_type": "digital"
}

published_reviews_count

number

required

Published customer reviews for this product.

Example:

0

route

string

required

URL slug for the product's public link.

Example:

"interior-deep-clean"

title

string

required

Product display name shown to customers.

Example:

"Interior Deep Clean"

updated_at

string

required

When the product was last updated, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

verified

boolean

required

Whether the product has been verified by Whop.

Example:

false

visibility

string | null

required

Whether the product is publicly visible, hidden, or archived.

Example:

"visible"

Introduction

Reference

Webhooks & Events

Core Resources

Notifications

Payments

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Authorizations

Headers

Path Parameters

Body

Response