Affiliate

{
  "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>"
  }
}

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

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

Retrieve ad

List affiliates

⌘I

Introduction

Developer

Ads

CRM

AI

Identity

Engagement

Payins

Courses

Payouts

Stats