Skip to main content
PATCH
TypeScript

Autorizaciones

Authorization
string
header
requerido

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

access_pass:update

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

The unique identifier of the product.

Cuerpo

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.

description
string | null

A written description displayed on the product page. Maximum 1,500 characters.

Maximum string length: 1500
Ejemplo:

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

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
headline
string | null

A short marketing headline for the product page. Maximum 80 characters.

Maximum string length: 80
Ejemplo:

"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.

Ejemplo:
product_tax_code_id
string | null

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

Ejemplo:

"ptc_xxxxxxxxxxxxxx"

send_welcome_message
boolean | null

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

Ejemplo:

true

title
string

The display name of the product. Maximum 80 characters.

Maximum string length: 80
Ejemplo:

"Interior Deep Clean"

visibility
string

Whether the product is visible to customers.

Ejemplo:

"visible"

Respuesta

product tax code updated

account
object | null
requerido

Account that sells this product.

Ejemplo:
average_review_rating
number
requerido

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.

Ejemplo:

0

created_at
string
requerido

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

Ejemplo:

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

custom_cta
enum<string> | null
requerido

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

Opciones disponibles:
get_access,
join,
order_now,
shop_now,
call_now,
donate_now,
contact_us,
sign_up,
subscribe,
purchase,
get_offer,
apply_now,
complete_order,
null
Ejemplo:

"order_now"

custom_cta_url
string | null
requerido

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

Ejemplo:

"https://shinetime.example/book"

custom_statement_descriptor
string | null
requerido

Custom text label on customer's bank statement.

Ejemplo:

"WHOP*SHINETIME"

default_variant
object | null
requerido

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

description
string | null
requerido

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

Ejemplo:

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

experiences
object[]
requerido
external_identifier
string | null
requerido

External identifier stored on the product for your own reference.

Ejemplo:

"SHINE-CERAMIC-01"

global_affiliate_percentage
number | null
requerido

Commission rate affiliates earn through the global affiliate program.

Ejemplo:

10

global_affiliate_status
enum<string> | null
requerido

Enrollment status in the global affiliate program.

Opciones disponibles:
enabled,
disabled,
null
Ejemplo:

"enabled"

headline
string | null
requerido

Short marketing headline displayed on product page.

Ejemplo:

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

id
string
requerido

Product ID, prefixed prod_.

Ejemplo:

"prod_xxxxxxxxxxxxxx"

labels
string[]
requerido

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

logo_url
string | null
requerido

Logo image URL shown on product pages and in search results. null when the product has no logo.

Ejemplo:

null

marketplace_status
enum<string>
requerido

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

Opciones disponibles:
not_available,
pending_review,
live_marketplace
Ejemplo:

"not_available"

member_affiliate_percentage
number | null
requerido

Commission rate members earn through the member affiliate program.

Ejemplo:

5

member_affiliate_status
enum<string> | null
requerido

Enrollment status in the member affiliate program.

Opciones disponibles:
enabled,
disabled,
null
Ejemplo:

"enabled"

member_count
number
requerido

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

Ejemplo:

0

metadata
object | null
requerido

Custom key-value pairs stored on the product.

Ejemplo:
owner_user
object | null
requerido

User who owns the account selling this product.

Ejemplo:
product_tax_code
object | null
requerido

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

Ejemplo:
published_reviews_count
number
requerido

Published customer reviews for this product.

Ejemplo:

0

route
string
requerido

URL slug for the product's public link.

Ejemplo:

"interior-deep-clean"

title
string
requerido

Product display name shown to customers.

Ejemplo:

"Interior Deep Clean"

updated_at
string
requerido

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

Ejemplo:

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

variant_attributes
object | null
requerido

The option set the product's variants span, as a map of attribute name to the values in use, e.g. {"color": ["Blue", "Red"], "size": ["S", "M", "L"]}. Derived from the visible, non-invoice variants that carry attributes: keys alphabetical, values in the order the variants were created. Read-only. null when the product has no variants.

Ejemplo:
variants
object[] | null
requerido
verified
boolean
requerido

Whether the product has been verified by Whop.

Ejemplo:

false

visibility
string | null
requerido

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

Ejemplo:

"visible"