Product

A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold.

Endpoints

Endpoint	Request
List Products	GET `/products`
Create Product	POST `/products`
Retrieve Product	GET `/products/{id}`
Update Product	PATCH `/products/{id}`
Delete Product	DELETE `/products/{id}`
Publish Product	POST `/products/{id}/publish`
Unpublish Product	POST `/products/{id}/unpublish`

Attributes

string

required

Product ID, prefixed prod_.

object | null

required

Account that sells this product.

string

required

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

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

string | null

required

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

string | null

required

Custom text label on customer’s bank statement.

string | null

required

Written description displayed on product page.

string | null

required

External identifier stored on the product for your own reference.

object[]

required

Gallery images for this product, ordered by position.

Properties

string

required

Gallery image ID.

string | null

required

Uploaded file MIME type, such as image/jpeg.

string | null

required

Pre-optimized URL for rendering this image on the client.

number | null

required

Commission rate affiliates earn through the global affiliate program.

string | null

required

Enrollment status in the global affiliate program.Available options: enabled, disabled

string | null

required

Short marketing headline displayed on product page.

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

number | null

required

Commission rate members earn through the member affiliate program.

string | null

required

Enrollment status in the member affiliate program.Available options: enabled, disabled

number

required

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

object | null

required

Custom key-value pairs stored on the product.

object | null

required

User who owns the account selling this product.

object | null

required

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

number

required

Published customer reviews for this product.

string

required

URL slug for the product’s public link.

string

required

Product display name shown to customers.

string

required

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

boolean

required

Whether the product has been verified by Whop.

string | null

required

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

Product

{
	"id": "prod_xxxxxxxxxxxxx",
	"account": {
		"id": "biz_xxxxxxxxxxxxxx",
		"route": "pickaxe",
		"title": "Pickaxe"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"custom_cta": "get_access",
	"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": [
		{
			"id": "file_xxxxxxxxxxxxx",
			"content_type": "image/jpeg",
			"url": "https://media.whop.com/abc123/optimized.jpg"
		}
	],
	"global_affiliate_percentage": 6.9,
	"global_affiliate_status": "enabled",
	"headline": "Real-time data analytics for creators",
	"marketplace_status": "live_marketplace",
	"member_affiliate_percentage": 6.9,
	"member_affiliate_status": "enabled",
	"member_count": 42,
	"metadata": {
		"external_product_id": "prod_123"
	},
	"owner_user": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	},
	"product_tax_code": {
		"id": "ptc_xxxxxxxxxxxxxx",
		"name": "Digital - SaaS",
		"product_type": "digital"
	},
	"published_reviews_count": 12,
	"route": "pickaxe-analytics",
	"title": "Pickaxe Analytics",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"verified": true,
	"visibility": "visible"
}

Introduction

Reference

Core Resources

Notifications

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Endpoints

Attributes

​Endpoints

​Attributes

Endpoints

Attributes