> For the complete documentation index, see [llms.txt](https://docs.sparkloop.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sparkloop.app/api-v2-deprecated/objects-schema/subscriber-object.md).

# Subscriber Object

### Example

```json
{
  "uuid": "sub_4bc1056297",
  "email": "drago@sparkloop.app",
  "name": null,
  "ref_code": "c784ef4f",
  "referrer_code": null,
  "referred": true,
  "referral_status": "verified",
  "ip_address": null,
  "user_agent": null,
  "origin": "signup",
  "country_code": "US",
  "cpa": 5.0,
  "utm_source": null,
  "utm_campaign": null,
  "created_at": "2021-03-24T11:55:02.113Z"
}
```

<table><thead><tr><th width="217">Property</th><th width="140.66666666666666">Type</th><th>Description</th></tr></thead><tbody><tr><td>uuid</td><td>string</td><td>the unique ID of the subscriber</td></tr><tr><td>email</td><td>string</td><td>the email address of the subscriber</td></tr><tr><td>name</td><td>string</td><td>the name of the subscriber</td></tr><tr><td>ref_code</td><td>string</td><td>the referral code of the subscriber</td></tr><tr><td>referrer_code</td><td>string</td><td>the referral code of the subscriber's referrer</td></tr><tr><td>referred</td><td>boolean</td><td>flag to indicate whether this subscriber was referred</td></tr><tr><td>referral_status</td><td>string</td><td>the referral status of the subscriber. Possible values: verified, pending, rejected.</td></tr><tr><td>ip_address</td><td>string</td><td>the ip address of the subscriber</td></tr><tr><td>user_agent</td><td>string</td><td>the user agent of the subscriber</td></tr><tr><td>origin</td><td>string</td><td>the origin of the subscriber. For example: "signup", "sparkloop-upscribe", etc</td></tr><tr><td>cpa</td><td>float</td><td>the cpa of the subscriber (for subscribers acquired via paid channels only)</td></tr><tr><td>utm_source</td><td>string</td><td>the acquisition source of the subscriber</td></tr><tr><td>utm_campaign</td><td>string</td><td>the acquistion campaign of the subscriber</td></tr><tr><td>created_at</td><td>timestamp</td><td>the date the subscriber was created</td></tr></tbody></table>