Skip to main content
POST
TypeScript

Autorisaties

Authorization
string
header
vereist

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

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Voorbeeld:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

The unique identifier of the product, prefixed prod_.

Respons

product submitted for review

account
object | null
vereist

Account that sells this product.

Voorbeeld:
average_review_rating
number
vereist

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.

Voorbeeld:

0

created_at
string
vereist

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

Voorbeeld:

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

custom_cta
enum<string> | null
vereist

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

Beschikbare opties:
get_access,
join,
order_now,
shop_now,
call_now,
donate_now,
contact_us,
sign_up,
subscribe,
purchase,
get_offer,
apply_now,
complete_order,
null
Voorbeeld:

"order_now"

custom_cta_url
string | null
vereist

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

Voorbeeld:

"https://shinetime.example/book"

custom_statement_descriptor
string | null
vereist

Custom text label on customer's bank statement.

Voorbeeld:

"WHOP*SHINETIME"

default_variant
object | null
vereist

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
vereist

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

Voorbeeld:

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

experiences
object[]
vereist
external_identifier
string | null
vereist

External identifier stored on the product for your own reference.

Voorbeeld:

"SHINE-CERAMIC-01"

global_affiliate_percentage
number | null
vereist

Commission rate affiliates earn through the global affiliate program.

Voorbeeld:

10

global_affiliate_status
enum<string> | null
vereist

Enrollment status in the global affiliate program.

Beschikbare opties:
enabled,
disabled,
null
Voorbeeld:

"enabled"

headline
string | null
vereist

Short marketing headline displayed on product page.

Voorbeeld:

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

id
string
vereist

Product ID, prefixed prod_.

Voorbeeld:

"prod_xxxxxxxxxxxxxx"

labels
string[]
vereist

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

logo_url
string | null
vereist

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

Voorbeeld:

null

marketplace_status
enum<string>
vereist

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

Beschikbare opties:
not_available,
pending_review,
live_marketplace
Voorbeeld:

"not_available"

member_affiliate_percentage
number | null
vereist

Commission rate members earn through the member affiliate program.

Voorbeeld:

5

member_affiliate_status
enum<string> | null
vereist

Enrollment status in the member affiliate program.

Beschikbare opties:
enabled,
disabled,
null
Voorbeeld:

"enabled"

member_count
number
vereist

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

Voorbeeld:

0

metadata
object | null
vereist

Custom key-value pairs stored on the product.

Voorbeeld:
owner_user
object | null
vereist

User who owns the account selling this product.

Voorbeeld:
product_tax_code
object | null
vereist

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

Voorbeeld:
published_reviews_count
number
vereist

Published customer reviews for this product.

Voorbeeld:

0

route
string
vereist

URL slug for the product's public link.

Voorbeeld:

"interior-deep-clean"

title
string
vereist

Product display name shown to customers.

Voorbeeld:

"Interior Deep Clean"

updated_at
string
vereist

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

Voorbeeld:

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

variant_attributes
object | null
vereist

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.

Voorbeeld:
variants
object[] | null
vereist
verified
boolean
vereist

Whether the product has been verified by Whop.

Voorbeeld:

false

visibility
string | null
vereist

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

Voorbeeld:

"visible"