Company

{
	"affiliate_instructions": "Share your unique link on social media to earn 20% commission.",
	"created_at": "2023-12-01T05:00:00.401Z",
	"description": "Learn the fundamentals of data analytics with hands-on projects.",
	"featured_affiliate_product": {
		"id": "prod_xxxxxxxxxxxxx",
		"name": "<string>"
	},
	"id": "biz_xxxxxxxxxxxxxx",
	"logo": {
		"url": "https://media.whop.com/abc123/optimized.jpg"
	},
	"member_count": 42,
	"metadata": {},
	"owner_user": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	},
	"published_reviews_count": 42,
	"route": "pickaxe",
	"send_customer_emails": true,
	"social_links": [
		{
			"id": "soci_xxxxxxxxxxxxx",
			"url": "https://x.com/whop",
			"website": "x"
		}
	],
	"target_audience": "<string>",
	"title": "Pickaxe",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"verified": true
}

string | null

required

Guidelines and instructions provided to affiliates explaining how to promote this company’s products.Example: Share your unique link on social media to earn 20% commis…

string<date-time>

required

The datetime the company was created.Example: 2023-12-01T05:00:00.401Z

string | null

required

A promotional pitch written by the company creator, displayed to potential customers on the store page.Example: Learn the fundamentals of data analytics with hands-on pr…

object | null

required

The product featured for affiliates to promote on this company’s affiliate page. Null if none is configured.

Show child attributes

string

required

The unique identifier for the product.Example: prod_xxxxxxxxxxxxx

string

required

The display name of the product shown to customers. Maximum 50 characters.

string

required

The unique identifier for the company.Example: biz_xxxxxxxxxxxxxx

object | null

required

The company’s logo.

Show child attributes

string | null

required

A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.Example: https://media.whop.com/abc123/optimized.jpg

integer

required

The total number of users who currently hold active memberships across all of this company’s products.Example: 42

object | null

required

A key-value JSON object of custom metadata for this company, managed by the platform that created the account.

object

required

The user who owns and has full administrative control over this company.

Show child attributes

string

required

The unique identifier for the user.Example: user_xxxxxxxxxxxxx

string | null

required

The user’s display name shown on their public profile.Example: John Doe

string

required

The user’s unique username shown on their public profile.Example: johndoe42

integer

required

The total number of published customer reviews across all products for this company.Example: 42

string

required

URL slug for the account’s store page, e.g. pickaxe in whop.com/pickaxe.Example: pickaxe

boolean

required

Whether Whop sends transactional emails (receipts, updates) to customers on behalf of this company.

The list of social media accounts and external links associated with this company.

Show child attributes

string

required

The unique identifier for the social link.Example: soci_xxxxxxxxxxxxx

string

required

The URL of the social media profile or external link.Example: https://x.com/whop

SocialLinkWebsites

required

The websiteAvailable options: x, instagram, facebook, tiktok, youtube, linkedin, twitch, website, custom

string | null

required

The target audience for the company. Null if not set.

string

required

The display name of the company shown to customers.Example: Pickaxe

string<date-time>

required

The datetime the company was last updated.Example: 2023-12-01T05:00:00.401Z

boolean

required

Whether this company has been verified by Whop’s trust and safety team.

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats