Skip to main content
{
	"active_members_count": 42,
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"title": "<string>"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"customer_retention_rate": "<string>",
	"customer_retention_rate_ninety_days": "<string>",
	"id": "aff_xxxxxxxxxxxxxx",
	"monthly_recurring_revenue_usd": "<string>",
	"status": "active",
	"total_overrides_count": 42,
	"total_referral_earnings_usd": "<string>",
	"total_referrals_count": 42,
	"total_revenue_usd": "<string>",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"user": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "Jane Smith",
		"username": "janesmith"
	}
}
​
active_members_count
integer
required
The total active members of the affiliateExample: 42
​
company
object
required
The company attached to this affiliate
​
created_at
string<date-time>
required
The datetime the affiliate was created.Example: 2023-12-01T05:00:00.401Z
​
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
​
id
string
required
The unique identifier for the affiliate.Example: aff_xxxxxxxxxxxxxx
​
monthly_recurring_revenue_usd
string
required
The monthly recurring revenue generated by this affiliate’s referrals, formatted as a USD currency string
​
status
Status | null
required
The status of the affiliateAvailable options: active, archived, deleted
​
total_overrides_count
integer
required
The total count of all overrides for this affiliateExample: 42
​
total_referral_earnings_usd
string
required
The total commission earnings paid to this affiliate, formatted as a USD currency string
​
total_referrals_count
integer
required
The total referrals of the affiliateExample: 42
​
total_revenue_usd
string
required
The total revenue generated from this affiliate’s referrals, formatted as a USD currency string
​
updated_at
string<date-time>
required
The datetime the affiliate was last updated.Example: 2023-12-01T05:00:00.401Z
​
user
object
required
The user attached to this affiliate