Fanvue API Documentation

Three events share the subscription resource. They are delivered in the Standard-Webhooks envelope; the fields below describe the data object.

Event (`type`)	Fires when
`checkout_link.subscription.activated`	A subscription becomes active via a checkout link
`checkout_link.subscription.deactivated`	A subscription ends (expired or otherwise deactivated)
`checkout_link.subscription.cancel_at_period_end_changed`	Auto-renew is turned off or back on

A subscription is a fan’s active, recurring access to a product sold through a checkout link. Fanvue models cancellation as cancel_at_period_end plus an expires_at, not an immediate removal: a fan who cancels keeps access until expires_at, and the deactivated event fires when access actually ends.

Subscription resource

Field	Type	Description
`object`	string	Always `"subscription"`
`id`	string	Subscription UUID
`status`	string	`active` \| `cancelled` \| `expired`
`cancel_at_period_end`	boolean	Whether the subscription will stop renewing at `expires_at`
`expires_at`	string \| null	ISO 8601 end of the current period
`created_at`	string \| null	ISO 8601 time the subscription started
`client_reference_id`	string \| null	Your passthrough reference (see Attribution)
`deactivation_reason`	string \| null	Why the subscription ended (e.g. `NON_RENEWING`); `null` while active
`checkout_link`	object	`{ uuid, name, product_uuid, product_price_uuid }`
`purchaser`	object	`{ uuid, email }` of the subscriber (`email` may be `null`)
`creator`	object	`{ uuid }` of the creator
`metadata`	object	Your passthrough metadata map

Examples

`checkout_link.subscription.activated`

{
  "id": "f1a2b3c4-4444-4a2b-9c3d-aaaaaaaaaaaa",
  "type": "checkout_link.subscription.activated",
  "timestamp": "2026-06-09T08:00:00.000Z",
  "data": {
    "object": "subscription",
    "id": "sub-uuid",
    "status": "active",
    "cancel_at_period_end": false,
    "expires_at": "2026-07-09T08:00:00.000Z",
    "created_at": "2026-06-09T08:00:00.000Z",
    "client_reference_id": "your-crm-id-123",
    "deactivation_reason": null,
    "checkout_link": {
      "uuid": "ck-uuid",
      "name": "VIP Monthly",
      "product_uuid": "prod-uuid",
      "product_price_uuid": "pp-uuid"
    },
    "purchaser": { "uuid": "fan-uuid", "email": "fan@example.com" },
    "creator": { "uuid": "creator-uuid" },
    "metadata": { "affiliate_id": "aff_123", "campaign": "spring" }
  }
}

`checkout_link.subscription.cancel_at_period_end_changed`

{
  "id": "f1a2b3c4-6666-4a2b-9c3d-aaaaaaaaaaaa",
  "type": "checkout_link.subscription.cancel_at_period_end_changed",
  "timestamp": "2026-06-20T08:00:00.000Z",
  "data": {
    "object": "subscription",
    "id": "sub-uuid",
    "status": "cancelled",
    "cancel_at_period_end": true,
    "expires_at": "2026-07-09T08:00:00.000Z",
    "created_at": "2026-06-09T08:00:00.000Z",
    "client_reference_id": "your-crm-id-123",
    "deactivation_reason": null,
    "checkout_link": {
      "uuid": "ck-uuid",
      "name": "VIP Monthly",
      "product_uuid": "prod-uuid",
      "product_price_uuid": "pp-uuid"
    },
    "purchaser": { "uuid": "fan-uuid", "email": "fan@example.com" },
    "creator": { "uuid": "creator-uuid" },
    "metadata": { "affiliate_id": "aff_123", "campaign": "spring" }
  }
}

`checkout_link.subscription.deactivated`

{
  "id": "f1a2b3c4-5555-4a2b-9c3d-aaaaaaaaaaaa",
  "type": "checkout_link.subscription.deactivated",
  "timestamp": "2026-07-09T08:00:00.000Z",
  "data": {
    "object": "subscription",
    "id": "sub-uuid",
    "status": "expired",
    "cancel_at_period_end": false,
    "expires_at": "2026-07-09T08:00:00.000Z",
    "created_at": "2026-06-09T08:00:00.000Z",
    "client_reference_id": "your-crm-id-123",
    "deactivation_reason": "NON_RENEWING",
    "checkout_link": {
      "uuid": "ck-uuid",
      "name": "VIP Monthly",
      "product_uuid": "prod-uuid",
      "product_price_uuid": "pp-uuid"
    },
    "purchaser": { "uuid": "fan-uuid", "email": "fan@example.com" },
    "creator": { "uuid": "creator-uuid" },
    "metadata": { "affiliate_id": "aff_123", "campaign": "spring" }
  }
}

Managing subscriptions

The events above fire regardless of how a subscription changes. A creator can also drive cancel_at_period_end themselves, from the Fanvue dashboard or through the API.

Endpoint	What it does
`GET /creators/{creatorUserUuid}/checkout-links/subscriptions`	Lists a creator’s checkout-link subscriptions, most recent first, with cursor pagination. Defaults to `status=active`; also accepts `cancelled`, `expired`, and `all`, plus `checkoutLinkUuid` and `fanUuid` filters.
`POST /creators/{creatorUserUuid}/checkout-links/subscriptions/{uuid}/cancel`	Stops the subscription renewing. Emits `cancel_at_period_end_changed`.
`POST /creators/{creatorUserUuid}/checkout-links/subscriptions/{uuid}/uncancel`	Reverses a pending cancellation so it renews again. Emits `cancel_at_period_end_changed` with `cancel_at_period_end: false`.

Listing requires the read:creator scope and the earnings:read creator permission. Cancel and uncancel require write:creator and monetization:manage. Full request and response shapes are in the API Reference.

These endpoints return the subscription in camelCase (cancelAtPeriodEnd, expiresAt), while the webhook data object above uses snake_case (cancel_at_period_end, expires_at). The same subscription reaches you under both spellings depending on which side you read it from.

A subscription scheduled to cancel is still status: active with cancelAtPeriodEnd: true. It only becomes expired at expiresAt, which is when deactivated fires. So status=cancelled lists subscriptions that are still running and still have access, not ones that have ended.

Only a cancellation the creator made themselves can be reversed. If the subscriber cancelled, or Fanvue support did, or the cancellation predates actor tracking and reports cancelledBy: null, uncancel returns 409 and the cancellation stands. In that case the subscriber restarts their own subscription by purchasing again. Cancelling a subscription whose renewal is still being retried stops further charge attempts immediately. Access has already lapsed, so the response reports status: expired and no webhook fires: deactivated was already emitted when the failed renewal ended the subscription.

Overview

Creator events

Checkout

App webhooks

Legacy events (deprecated)

Checkout Subscription Events

Subscription resource

Examples

`checkout_link.subscription.activated`

`checkout_link.subscription.cancel_at_period_end_changed`

`checkout_link.subscription.deactivated`

Managing subscriptions

​Subscription resource

​Examples

​checkout_link.subscription.activated

​checkout_link.subscription.cancel_at_period_end_changed

​checkout_link.subscription.deactivated

​Managing subscriptions

Subscription resource

Examples

`checkout_link.subscription.activated`

`checkout_link.subscription.cancel_at_period_end_changed`

`checkout_link.subscription.deactivated`

Managing subscriptions