Your affiliate referral dashboard

gethttps://api.expiryedge.com/v1/getMyReferral
any role (self only)60/min
Anfrage
curl 'https://api.expiryedge.com/v1/getMyReferral' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "hasReferralCode": true,
  "referralCode": {
    "referral_code": "CONTOSO25",
    "referee_name": "Contoso Legal",
    "referee_email": "partners@contosolegal.com",
    "active": true
  },
  "referredOrgs": [
    {
      "organization_id": "org_northwind",
      "organization_name": "Northwind Dental",
      "organization_domain": "northwinddental.com",
      "subscription_plan": "pro",
      "subscription_status": "active",
      "referred_at": "2026-09-27T14:05:00.000Z",
      "discount_percentage": 25,
      "referrer_commission_percentage": 20,
      "last_payment_amount": 290,
      "events": [],
      "org_revenue": 290,
      "org_commission": 58
    }
  ],
  "commissions": [],
  "events": [],
  "revenueByPeriod": [
    {
      "year": 2026,
      "month": 9,
      "revenue": 290,
      "commission": 58,
      "payments": 1,
      "label": "Sep 2026"
    }
  ],
  "revenueByYear": [
    {
      "year": 2026,
      "revenue": 290,
      "commission": 58,
      "payments": 1
    }
  ],
  "stats": {
    "totalReferrals": 1,
    "activeSubscribers": 1,
    "totalRevenueGenerated": 290,
    "totalRefunded": 0,
    "netRevenue": 290,
    "totalCommissionEarned": 58,
    "pendingCommission": 58,
    "conversionRate": 100,
    "commissionPercentage": 20
  }
}

Finds the referral code whose referee is the caller and returns referred organizations, commissions (latest 200), events and revenue totals. hasReferralCode: false when the caller has no code.

Rückgabe

200
Referral summary.
  • hasReferralCodebooleanerforderlich
  • referralCodeobject | null
  • referredOrgsarray of objects
  • commissionsarray of objects
    Commission log entries, newest first (max 200).
  • eventsarray of objects
    Referral events (payments, refunds, cancellations), newest first.
  • revenueByPeriodarray of objects
  • revenueByYeararray of objects
  • statsobject

Fehler

401
Missing, expired or invalid bearer token.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.