> 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/partner-program-object.md).

# Partner Program Object

### Example

```json
{
  "uuid": "partner_program_45e5187ede44",
  "publication": {
    "uuid": "pub_810f4c8c08cd",
    "name": "The Pour Over",
    "logo" : "https://dash.sparkloop.app/rails/active_storage/representations/stamp.jpeg",
    "description": "The day's biggest news paired with foundational Biblical principles. Join over 250,000 delighted subscribers!",
    "url": "https://www.thepourover.org/",
    "send_frequency": "1-2x per month",
    "language": "English",
    "categories": ["religion", "politics", "lifestyle"]
  },
  "status": "active",
  "terms": null,
  "redirect_url": "https://www.thepourover.org/",
  "cpa": 2.0,
  "max_payout": 500.0,
  "referral_pending_duration": 10,
  "geo_restrictions": {
    "allow_worldwide_referrals": false,
    "allowed_countries": ["GB", "CA"],
    "blocked_countries": []
  },
  "screening_strictness": "not_enough_data",
  "expected_earning_per_referral": "$3",
  "expected_referral_confirmation_rate": 75,
  "requires_approval": true,
  "created_at": "2022-11-23T15:04:36.143Z"
}
```

| Property                               | Type      | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| -------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| uuid                                   | string    | the unique ID of the partner program                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| publication                            | object    | the partner program's publication. The object includes the publication's UUID, name, description, URL, send\_frequency, language and categories                                                                                                                                                                                                                                                                                                                       |
| status                                 | string    | the status of the partner program                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| terms                                  | string    | custom terms and conditions of the publication                                                                                                                                                                                                                                                                                                                                                                                                                        |
| redirect\_url                          | string    | the URL people are redirected to when they click on the partner link                                                                                                                                                                                                                                                                                                                                                                                                  |
| cpa                                    | float     | how much this partner program pays per confirmed subscriber                                                                                                                                                                                                                                                                                                                                                                                                           |
| max\_payout                            | float     | the most a single partner can earn from this program in a month, in US dollars                                                                                                                                                                                                                                                                                                                                                                                        |
| referral\_pending\_duration            | integer   | how many days subscribers have to stay subscribed before they are confirmed.                                                                                                                                                                                                                                                                                                                                                                                          |
| geo\_restrictions                      | object    | <p>the geo-restrictions applied to this partner program. The object includes:</p><ul><li>allow\_worldwide\_referrals (boolean)</li><li>allowed\_countries (array) -> which countries are allowed (Alpha-2 ISOCODE)</li><li>blocked\_countries (array) -> which countries are blocked (Alpha-2 ISOCODE)</li><li>allowed\_regions (array) -> allowed regions (states) in the US (Alpha-2 ISOCODE) (present only when impressions are restricted to US states)</li></ul> |
| screening\_strictness                  | string    | <p>how strict is the screening of this partner program<br><br>returns exceptionally\_strict/strict/fair/very\_fair when there is enough data<br><br>otherwise returns not\_enough\_data</p>                                                                                                                                                                                                                                                                           |
| expected\_referral\_confirmation\_rate | integer   | the confirmation rate a good-fit partner should expect as a % (0-100)                                                                                                                                                                                                                                                                                                                                                                                                 |
| expected\_earning\_per\_referral       | string    | the amount of earnings expected per referral                                                                                                                                                                                                                                                                                                                                                                                                                          |
| requires\_approval                     | boolean   | <p>If the partner program requires approval.<br><br><em>Note: Only present when fetching a partner program from the Partner Network endpoints.</em></p>                                                                                                                                                                                                                                                                                                               |
| created\_at                            | timestamp | the date the partner program was created                                                                                                                                                                                                                                                                                                                                                                                                                              |
