FAfanvue

Create a free trial link

Create a shareable link that lets fans start a free trial of the creator's subscription.

post/free-trial-links

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/free-trial-links
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: write:creator

Headers

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

API version to use for the request

Request body

maxUsagesinteger nullable

Maximum number of fans that can redeem the link. Unlimited when null or omitted.

expiresDaysinteger nullable

Number of days from now until the link expires. Never expires when null or omitted.

namestring nullable

Creator-facing label used to tell several links apart. Not shown to fans. Unnamed when null or omitted.

trialDurationDaysinteger nullable

Length of the free trial in days. Uses the platform default when null or omitted.

Response

Free trial link created successfully

uuidstring uuid required

Free trial link UUID

urlstring nullable required

Shareable URL fans use to redeem the free trial

maxUsagesinteger nullable required

Maximum number of redemptions (null if unlimited)

namestring nullable required

Creator-facing label for the link (null when the link is unnamed)

usedCountinteger required

Number of times the link has been redeemed

trialDurationDaysinteger nullable required

Free trial length in days (null when the platform default applies)

expiresAtstring date-time nullable required

When the link expires (null if it never expires)

createdAtstring date-time required

When the link was created

Changes

No recorded changes to this operation across all 8 revisions of this API.