List a creator's checkout-link subscriptions

Changed on

List the specified creator's checkout-link product subscriptions, most recent first, with cursor-based pagination. Defaults to status=active (renewing); pass status=cancelled for active subscriptions scheduled to cancel at the period end (cancelAtPeriodEnd=true — their resource status stays active until they expire), status=expired for ended ones, or status=all. Filter by checkoutLinkUuid or fanUuid to narrow the list.

<Info> **Polling for real-time updates? Use a webhook instead.**

If you are calling this endpoint on a schedule to detect new activity, subscribe to the checkout_link.subscription.activated, checkout_link.subscription.deactivated, checkout_link.subscription.cancel_at_period_end_changed webhook events instead — you'll get pushed updates in real time without polling. See the webhook documentation. </Info>

get/creators/{creatorUserUuid}/checkout-links/subscriptions

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/creators/{creatorUserUuid}/checkout-links/subscriptions
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: read:creator

Path parameters

creatorUserUuidstring uuid required

Query parameters

limitinteger

Number of results to return (default 20, max 100).

cursorstring

Cursor for pagination, as returned in a previous page's nextCursor.

status'active' | 'cancelled' | 'expired' | 'all'

Filter (default active). active returns renewing subscriptions; cancelled returns active subscriptions scheduled to cancel at the period end (cancelAtPeriodEnd=true — their resource status is still active); expired returns ended subscriptions.

checkoutLinkUuidstring uuid

Filter to subscriptions purchased through this checkout link.

fanUuidstring uuid

Filter to subscriptions held by this fan.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

List of checkout-link subscriptions

nextCursorstring nullable required

Cursor for the next page, or null if none.

Changes