Create affiliate

Creates or finds an affiliate for a company and user.

Required permissions:

• affiliate:create

POST /affiliates

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const affiliate = await client.affiliates.create({
  company_id: 'biz_xxxxxxxxxxxxxx',
  user_identifier: 'user_identifier',
});

console.log(affiliate.id);

200

{
  "id": "aff_xxxxxxxxxxxxxx",
  "status": "active",
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "total_referrals_count": 42,
  "total_referral_earnings_usd": "<string>",
  "total_overrides_count": 42,
  "customer_retention_rate": "<string>",
  "customer_retention_rate_ninety_days": "<string>",
  "monthly_recurring_revenue_usd": "<string>",
  "total_revenue_usd": "<string>",
  "active_members_count": 42,
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "Jane Smith",
    "username": "janesmith"
  },
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "<string>"
  }
}

Authorizations

Authorization · string · header · required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Body

application/json

Parameters for CreateAffiliateRecord

company_id · string · required

The ID of the company to create the affiliate for.

Example:

"biz_xxxxxxxxxxxxxx"

user_identifier · string · required

The user identifier (username, email, user ID, or Discord ID).

Response

200

application/json

A successful response

An affiliate tracks a user's referral performance and commission earnings for a company, including retention rates, revenue metrics, and payout configurations.

id · string · required

The unique identifier for the affiliate.

Example:

"aff_xxxxxxxxxxxxxx"

status · enum<string> | null · required

The status of the affiliate

Available options: active, archived, deleted

created_at · string<date-time> · required

The datetime the affiliate was created.

Example:

"2023-12-01T05:00:00.401Z"

updated_at · string<date-time> · required

The datetime the affiliate was last updated.

Example:

"2023-12-01T05:00:00.401Z"

total_referrals_count · integer · required

The total referrals of the affiliate

Example:

42

total_referral_earnings_usd · string · required

The total commission earnings paid to this affiliate, formatted as a USD currency string

total_overrides_count · integer · required

The total count of all overrides for this affiliate

Example:

42

customer_retention_rate · string · required

The percentage of referred customers who are still active members

customer_retention_rate_ninety_days · string · required

The percentage of referred customers who remained active over the last 90 days

monthly_recurring_revenue_usd · string · required

The monthly recurring revenue generated by this affiliate's referrals, formatted as a USD currency string

total_revenue_usd · string · required

The total revenue generated from this affiliate's referrals, formatted as a USD currency string

active_members_count · integer · required

The total active members of the affiliate

Example:

42

user · object · required

The user attached to this affiliate

Show child attributes

company · object · required

The company attached to this affiliate

Show child attributes