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

# Payout Object

## Payout Object

A partner-network payout to your account.

| Field            | Type           | Description                                                                                                                     |
| ---------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `uuid`           | String         | Payout UUID.                                                                                                                    |
| `type`           | String         | Payout type.                                                                                                                    |
| `start_period`   | String         | Start of the period the payout covers.                                                                                          |
| `end_period`     | String         | End of the period the payout covers.                                                                                            |
| `paid_at`        | String \| null | When the payout was paid (ISO 8601), or `null` if not yet paid.                                                                 |
| `created_at`     | String         | When the payout was created (ISO 8601).                                                                                         |
| `amount`         | Number         | Payout amount, in dollars.                                                                                                      |
| `paid`           | Boolean        | Whether the payout has been paid.                                                                                               |
| `details`        | Array          | Per-publication breakdown of what this payout pays for. Present only with `expand=details`.                                     |
| `unpaid_details` | Array          | Confirmations from this period deferred to a future payout. Same shape as `details`. Present only with `expand=unpaid_details`. |

**`details[]` / `unpaid_details[]`**

| Field              | Type   | Description                                               |
| ------------------ | ------ | --------------------------------------------------------- |
| `publication_uuid` | String | The recommending publication.                             |
| `publication_name` | String | Its name.                                                 |
| `amount`           | Number | Amount attributed to this publication, in dollars.        |
| `line_items`       | Array  | Contributing recommendation/offer line items (see below). |

**`line_items[]`**

| Field         | Type    | Description                                      |
| ------------- | ------- | ------------------------------------------------ |
| `type`        | String  | `recommendation` or `offer`.                     |
| `uuid`        | String  | The recommendation or offer recommendation UUID. |
| `name`        | String  | Its name.                                        |
| `referrals`   | Integer | Referral count (`recommendation` line items).    |
| `conversions` | Integer | Conversion count (`offer` line items).           |
| `amount`      | Number  | Amount for this line item, in dollars.           |

**Example (`expand=details`)**

```json
{
  "uuid": "payout_3f4g5h",
  "type": "partner_network",
  "start_period": "2026-05-01",
  "end_period": "2026-05-31",
  "paid_at": "2026-06-05T00:00:00.000Z",
  "created_at": "2026-06-01T00:00:00.000Z",
  "amount": 235.0,
  "paid": true,
  "details": [
    {
      "publication_uuid": "pub_5fc782e24409",
      "publication_name": "The Daily Byte",
      "amount": 235.0,
      "line_items": [
        { "type": "recommendation", "uuid": "rec_a6224cd65cf3", "name": "The Morning Brew", "referrals": 80, "amount": 200.0 },
        { "type": "offer", "uuid": "offrec_5d6e7f", "name": "Acme Pro", "conversions": 14, "amount": 35.0 }
      ]
    }
  ]
}
```