Skip to main content
POST
Create a checkout link for a creator
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"

Path Parameters

creatorUserUuid
string<uuid>
required

Body

application/json
source
object
required

What the link sells: an existing price (existing_price), a new price on an existing product (existing_product), or a brand-new product (new_product).

description
string

Internal note shown only in the creator dashboard. Fans never see it.

Maximum string length: 500
redirectUrl
string<uri>

URL fans are redirected to after a successful purchase.

Response

Checkout link created successfully

uuid
string<uuid>
required

Checkout link UUID

name
string
required

Creator-internal label for the link (derived from the product name)

description
string | null
required

Creator-internal note (null when unset). Fans never see it.

url
string | null
required

Shareable checkout URL fans use to purchase

price
integer
required

Price in integer minor units of the currency (e.g. cents). 0 for free links.

currency
string
required

ISO-4217 currency code of the price

isRecurring
boolean
required

Whether purchases create a recurring subscription

cycleLength
integer | null
required

Billing cycle length (null for one-off prices)

cycleUnit
enum<string> | null
required

Billing cycle unit (null for one-off prices)

Available options:
day,
week,
month,
year
productUuid
string<uuid> | null
required

UUID of the product the link sells

productPriceUuid
string<uuid> | null
required

UUID of the product price the link sells

status
enum<string>
required

active links can be purchased; disabled links reject checkout until re-enabled

Available options:
active,
disabled
createdAt
string<date-time>
required

When the link was created