Skip to main content
GET
Retrieve affiliate

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 ***************************

Path Parameters

id
string
required

The unique identifier of the affiliate.

Example:

"aff_xxxxxxxxxxxxxx"

Response

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.

active_members_count
integer
required

The total active members of the affiliate

Example:

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
enum<string> | null
required

The status of the affiliate

Available options:
active,
archived,
deleted
total_overrides_count
integer
required

The total count of all overrides for this affiliate

Example:

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 affiliate

Example:

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