Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Affiliates

Retrieve affiliate

Retrieves the details of an existing affiliate.

Required permissions:

  • affiliate:basic:read
get/affiliates/{id}

Path parameters

idstring required
Example:aff_xxxxxxxxxxxxxx

The unique identifier of the affiliate.

Response

A successful response

active_members_countinteger required

The total active members of the affiliate

created_atstring date-time required

The datetime the affiliate was created.

customer_retention_ratestring required

The percentage of referred customers who are still active members

customer_retention_rate_ninety_daysstring required

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

idstring required

The unique identifier for the affiliate.

monthly_recurring_revenue_usdstring required

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

status'active' | 'archived' | 'deleted' required

Statuses for resources

total_overrides_countinteger required

The total count of all overrides for this affiliate

total_referral_earnings_usdstring required

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

total_referrals_countinteger required

The total referrals of the affiliate

total_revenue_usdstring required

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

updated_atstring date-time required

The datetime the affiliate was last updated.

Example response

{
  "active_members_count": 42,
  "company": {
    "id": "biz_xxxxxxxxxxxxxx"
  },
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "aff_xxxxxxxxxxxxxx",
  "total_overrides_count": 42,
  "total_referrals_count": 42,
  "updated_at": "2023-12-01T05:00:00.401Z",
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "Jane Smith",
    "username": "janesmith"
  }
}