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

# Partner Program Object

## Partner Program Object

The owner's view of their own partner program.

| Field                  | Type           | Description                                                                               |
| ---------------------- | -------------- | ----------------------------------------------------------------------------------------- |
| `uuid`                 | String         | Partner program UUID.                                                                     |
| `created_at`           | String         | When the program was created (ISO 8601).                                                  |
| `terms`                | String \| null | Engagement terms.                                                                         |
| `engagement_screening` | Object         | `days` — the screening window.                                                            |
| `geo_restrictions`     | Object         | `allow_worldwide_referrals`, `allowed_countries`, `blocked_countries`, `allowed_regions`. |
| `status`               | String         | Program status.                                                                           |
| `budget`               | Object         | Spend configuration and current-cycle usage (see below).                                  |
| `audience_fit`         | Object         | Target-audience preferences (see below).                                                  |
| `stats`                | Object         | Date-ranged performance. Present only with `expand=stats`.                                |

**`budget`**

| Field          | Type   | Description                                                    |
| -------------- | ------ | -------------------------------------------------------------- |
| `commission`   | Number | Per-referral commission, in dollars.                           |
| `monthly_cap`  | Number | The most the program can be charged per month.                 |
| `used`         | Number | Spend used in the current cycle.                               |
| `remaining`    | Number | Remaining budget in the current cycle.                         |
| `spend_pacing` | String | The spend-pacing strategy: `maximize_volume` or `daily_paced`. |

**`audience_fit`**

| Field          | Type   | Description                                         |
| -------------- | ------ | --------------------------------------------------- |
| `gender`       | String | `skew_male`, `skew_female`, or `any_gender`.        |
| `age`          | String | `younger_audience`, `older_audience`, or `any_age`. |
| `income_level` | String | `low_income`, `high_income`, or `any_income`.       |
| `categories`   | Array  | Preferred partner-network categories.               |

**`stats`** (only with `expand=stats`)

| Field       | Type   | Description                                            |
| ----------- | ------ | ------------------------------------------------------ |
| `referrals` | Object | `confirmed`, `pending`, `rejected`, `total` counts.    |
| `spend`     | Object | `confirmed`, `estimated_pending`, `total`, in dollars. |

**Example (`expand=stats`)**

```json
{
  "uuid": "pp_abcdef123",
  "created_at": "2025-03-01T10:00:00.000Z",
  "terms": "Send engaged US subscribers.",
  "engagement_screening": { "days": 7 },
  "geo_restrictions": {
    "allow_worldwide_referrals": false,
    "allowed_countries": ["us", "ca"],
    "blocked_countries": [],
    "allowed_regions": []
  },
  "status": "active",
  "budget": {
    "commission": 2.5,
    "monthly_cap": 2000.0,
    "used": 640.0,
    "remaining": 1360.0,
    "spend_pacing": "maximize_volume"
  },
  "audience_fit": {
    "gender": "any_gender",
    "age": "any_age",
    "income_level": "any_income",
    "categories": ["finance", "b2b"]
  },
  "stats": {
    "referrals": { "confirmed": 256, "pending": 40, "rejected": 12, "total": 308 },
    "spend": { "confirmed": 640.0, "estimated_pending": 100.0, "total": 740.0 }
  }
}
```