Product Affiliate - Whop Docs

A Product Affiliate represents a user’s enrollment in a product’s affiliate program. An enrollment can exist before the user makes a referral or earns a reward. Use the Product Affiliates API to list product affiliates for an account, search by affiliate name or username, and narrow the results by product, enrollment status, or signup date.

Endpoints

Endpoint	Request
List Product Affiliates	GET `/product_affiliates`

Attributes

string

required

Product affiliate ID, prefixed apaf_.

string

required

When the affiliate enrollment was created, as an ISO 8601 timestamp. Includes automatically created enrollments.

object

required

The product the affiliate is enrolled to promote.

Properties

string

required

Product ID, prefixed prod_.

string

required

Product display name.

integer

required

Number of distinct users referred by the affiliate to this product.

string

required

Whether the affiliate’s enrollment is active or archived.Available options: active, archived

object

required

Net rewards earned by the affiliate for this product after fees and reversals, in USD.

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.

object

required

The user enrolled as an affiliate.

Properties

string

required

User ID, prefixed user_.

string | null

required

The affiliate’s email address. Requires the member:email:read scope; null without it.

string | null

required

Display name.

object

required

Avatar wrapper; its url is always present, using a generated placeholder when the user set no picture.

Properties

string

required

Avatar image URL. Always present — a generated placeholder when the user set no picture.

string

required

Public username.

ProductAffiliate

{
	"id": "apaf_xxxxxxxxxxxxxx",
	"status": "active",
	"product": {
		"id": "prod_xxxxxxxxxxxxxx",
		"title": "Ceramic Coating Package"
	},
	"user": {
		"id": "user_xxxxxxxxxxxxxx",
		"name": "Dana Whitfield",
		"username": "danawhitfield",
		"email": "dana@example.com",
		"profile_picture": {
			"url": "https://ui-avatars.com/api/?name=Dana+Whitfield"
		}
	},
	"referred_users_count": 3,
	"total_reward_amount_usd": {
		"amount": "147.00",
		"currency": "usd",
		"decimals": 2,
		"display_decimals": 2
	},
	"created_at": "2026-08-20T11:00:00.000Z"
}

​Endpoints

​Attributes

Endpoints

Attributes