Skip to main content
POST
Create a free trial link
Required scope
  • write:creator — Modify creator profiles, settings, and creator-specific data.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Body

application/json
maxUsages
integer | null

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

Required range: x >= 1
expiresDays
integer | null

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

Required range: x >= 1
trialDurationDays
integer | null

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

Required range: x >= 1

Response

Free trial link created successfully

uuid
string<uuid>
required

Free trial link UUID

url
string | null
required

Shareable URL fans use to redeem the free trial

maxUsages
integer | null
required

Maximum number of redemptions (null if unlimited)

usedCount
integer
required

Number of times the link has been redeemed

trialDurationDays
integer | null
required

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

expiresAt
string<date-time> | null
required

When the link expires (null if it never expires)

createdAt
string<date-time>
required

When the link was created