Partner Program Object

Example

{
  "uuid": "partner_program_45e5187ede44",
  "publication": {
    "uuid": "pub_810f4c8c08cd",
    "name": "The Pour Over",
    "description": "The day's biggest news paired with foundational Biblical principles. Join over 250,000 delighted subscribers!",
    "url": "https://www.thepourover.org/",
    "categories": ["religion", "politics", "lifestyle"]
  },
  "status": "active",
  "terms": null,
  "resources_url": null,
  "redirect_url": "https://www.thepourover.org/",
  "thankyou_page_url": "https://www.thepourover.org/thank-you",
  "max_payout": 4000.0,
  "cpa": 2.0,
  "referral_pending_duration": 10,
  "geo_restrictions": {
    "allow_worldwide_referrals": false,
    "allowed_countries": ["GB", "CA"],
    "blocked_countries": []
  },
  "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 and categories

status

string

the status of the partner program

terms

string

custom terms and conditions of the publication

resources_url

string

the URL of the publication's resources like brand assets, testimonials, etc

redirect_url

string

the URL people are redirected to when they click on the partner link

thankyou_page_url

string

the URL people are redirected to when they click on a magic link

cpa

float

how much this partner program pays per confirmed subscriber

max_payout

float

the max amount a partner can earn per month

referral_pending_duration

integer

how many days subscribers have to stayed subscribed before they are confirmed.

geo_restrictions

object

the geo-restrictions applied to this partner program. The object includes:

  • allow_worldwide_referrals (boolean)

  • allowed_countries (array) -> which countries are allowed (Alpha-2 ISOCODE)

  • blocked_countries (array) -> which countries are blocked (Alpha-2 ISOCODE)

created_at

timestamp

the date the partner program was created

Last updated