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 search the public marketplace, list an account’s products, retrieve a product, and create, update, or delete products.

Replaces the Legacy Products resource. Existing Legacy integrations keep working; see API versions for the stability contract.

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.

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.

Properties

string

required

Plan ID, prefixed plan_.

number | null

required

Number of days between recurring charges, such as 30 for monthly or 365 for annual. null for one-time plans.

number | null

required

Access duration in days for expiration-based plans. null for plans without an expiration.

object

required

What checkout charges up front. amount is "0.00" when the first charge is free, such as a trial.

Properties

string

required

The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.

string

required

Three-letter ISO 4217 currency code, lowercase.

integer

required

How many decimal places the amount CARRIES — the precision the charge itself runs at.

integer

required

How many decimal places to SHOW. Usually equal to decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.

string

required

Billing model for this plan: one_time or renewal.Available options: renewal, one_time

object

required

The recurring charge every billing_period days. amount is "0.00" for one-time plans.

Properties

string

required

The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.

string

required

Three-letter ISO 4217 currency code, lowercase.

integer

required

How many decimal places the amount CARRIES — the precision the charge itself runs at.

integer

required

string | null

required

Plan display name shown to customers. null if no title has been set.

boolean

required

Whether the plan has unlimited stock.

string

required

Where this plan can be seen. visible plans appear on the product page.Available options: visible, hidden, archived, quick_link

string | null

required

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

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

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

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",
	"default_plan": {
		"id": "plan_xxxxxxxxxxxxx",
		"billing_period": 30,
		"expiration_days": null,
		"initial_price": {
			"amount": "29.00",
			"currency": "usd",
			"decimals": 2,
			"display_decimals": 2
		},
		"plan_type": "renewal",
		"renewal_price": {
			"amount": "29.00",
			"currency": "usd",
			"decimals": 2,
			"display_decimals": 2
		},
		"title": "Monthly",
		"unlimited_stock": true,
		"visibility": "visible"
	},
	"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",
	"labels": ["analytics", "creator-tools"],
	"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

Webhooks & events

Core Resources

Notifications

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Endpoints

Attributes

​Endpoints

​Attributes

Endpoints

Attributes