> ## Documentation Index
> Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Creator Payments

> creator.payment.succeeded for a creator's on-platform sales: posts, messages, media, and tips.

`creator.payment.succeeded` fires when an on-platform payment to the creator
settles: a paid post, a locked (PPV) message, a media purchase, or a tip. It is
the successor to the legacy `purchase.new` and `tip.new` events, carrying the
full money breakdown in one payload.

| Event (`type`)              | Resource | Fires when                                     |
| --------------------------- | -------- | ---------------------------------------------- |
| `creator.payment.succeeded` | payment  | An on-platform payment to the creator succeeds |

Requires the `read:creator` scope. Delivered in the
[Standard-Webhooks envelope](/creator/overview#event-envelope); the fields below
describe the `data` object.

<Note>
  Recurring subscription money is reported on the subscription resource, not
  here. Checkout-link sales fire the separate
  [`checkout_link.payment.succeeded`](/checkout/payments) event.
</Note>

## Payment resource

| Field                 | Type            | Description                                                           |
| --------------------- | --------------- | --------------------------------------------------------------------- |
| `object`              | string          | Always `"payment"`                                                    |
| `id`                  | string          | Fanvue payment / invoice identifier                                   |
| `status`              | string          | Always `"succeeded"` for this event                                   |
| `source`              | string          | What was bought: `post`, `message`, `media`, or `tip`                 |
| `billing_reason`      | string          | `one_time`, `subscription_initial`, or `subscription_renewal`         |
| `gross`               | integer         | Gross amount in minor units                                           |
| `net`                 | integer \| null | Creator net after fees, in minor units                                |
| `fees`                | object          | `{ fanvue_fee, transaction_fee }`, each integer minor units or `null` |
| `currency`            | string \| null  | ISO 4217 currency code                                                |
| `paid_in_full`        | boolean         | Whether the payment settled in full                                   |
| `client_reference_id` | string \| null  | Your passthrough reference from the original purchase                 |
| `transaction_id`      | string \| null  | Payment-processor transaction id                                      |
| `created_at`          | string \| null  | ISO 8601 time the payment was created                                 |
| `paid_at`             | string \| null  | ISO 8601 time the payment settled                                     |
| `purchaser`           | object          | `{ uuid, email }` of the buyer (`email` may be `null`)                |
| `creator`             | object          | `{ uuid }` of the creator                                             |
| `metadata`            | object          | Your passthrough metadata map                                         |

### Example: `creator.payment.succeeded`

```json theme={null}
{
  "id": "f1a2b3c4-1111-4a2b-9c3d-aaaaaaaaaaaa",
  "type": "creator.payment.succeeded",
  "timestamp": "2026-06-09T08:39:33.139Z",
  "data": {
    "object": "payment",
    "id": "FV-12345",
    "status": "succeeded",
    "source": "message",
    "billing_reason": "one_time",
    "gross": 1999,
    "net": 1799,
    "fees": { "fanvue_fee": 200, "transaction_fee": 0 },
    "currency": "USD",
    "paid_in_full": true,
    "client_reference_id": "your-crm-id-123",
    "transaction_id": "txn_abc",
    "created_at": "2026-06-09T08:39:33.000Z",
    "paid_at": "2026-06-09T08:39:33.139Z",
    "purchaser": { "uuid": "fan-uuid", "email": "fan@example.com" },
    "creator": { "uuid": "creator-uuid" },
    "metadata": { "campaign": "spring-promo" }
  }
}
```