Show Referral - Reditus docs

GET

referrals

{id}

Get Referral

curl --request GET \
  --url https://api.getreditus.com/api/v1/referrals/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "email": "<string>",
      "state": "<string>",
      "state_set_at": 123,
      "created_at": 123,
      "updated_at": 123
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Response

200 - application/json

Successful response

data

object

Show child attributes

Churn ReferralMarks a referral as churned, so it no longer counts as an active paying referral. Use this when a referral cancels their subscription. Identify the referral by your own `referral_uid`, the referral's `referral_email`, or the Reditus `referral_id` - the same identifiers you use when creating a payment. If the referral pays again afterwards, sending a new payment automatically reactivates it, so no history is lost.

Get Referral

curl --request GET \
  --url https://api.getreditus.com/api/v1/referrals/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "email": "<string>",
      "state": "<string>",
      "state_set_at": 123,
      "created_at": 123,
      "updated_at": 123
    }
  }
}