Skip to main content
POST
JavaScript

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

Idempotency-Key
string

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

Maximum string length: 255
Example:

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

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-13"

Path Parameters

id
string
required

The unique identifier of the product, prefixed prod_.

Response

product submitted for review

account
object | null
required

Account that sells this product.

Example:
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"

description
string | null
required

Written description displayed on product page.

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"

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"

id
string
required

Product ID, prefixed prod_.

Example:

"prod_xxxxxxxxxxxxxx"

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:
owner_user
object | null
required

User who owns the account selling this product.

Example:
product_tax_code
object | null
required

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

Example:
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"