FAfanvue

Create a checkout link

Changed on

Create a shareable checkout link selling either an existing product price (existing_price), a new price on an existing product (existing_product), or a brand-new product (new_product).

All amounts are integer minor units of the currency (e.g. cents: 1999 = $19.99); the Fanvue dashboard displays the same prices in major units. Requires checkout links to be enabled for the creator.

post/checkout-links

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/checkout-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

descriptionstring

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

redirectUrlstring uri

URL fans are redirected to after a successful purchase.

Response

Checkout link created successfully

uuidstring uuid required

Checkout link UUID

namestring required

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

descriptionstring nullable required

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

urlstring nullable required

Shareable checkout URL fans use to purchase

priceinteger required

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

currencystring required

ISO-4217 currency code of the price

isRecurringboolean required

Whether purchases create a recurring subscription

cycleLengthinteger nullable required

Billing cycle length (null for one-off prices)

cycleUnit'day' | 'week' | 'month' | 'year' nullable required

Billing cycle unit (null for one-off prices)

productUuidstring uuid nullable required

UUID of the product the link sells

productPriceUuidstring uuid nullable required

UUID of the product price the link sells

taxBehavior'exclusive' | 'inclusive' required

Tax basis stamped on the price when it was created. exclusive: the fan pays the price plus tax. inclusive: the price is what the fan pays, tax carved out of it.

displayCurrency'localised' | 'usd' required

Currency the checkout page shows the fan. localised: the fan's local currency where a rate exists. usd: always USD.

status'active' | 'disabled' required

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

createdAtstring date-time required

When the link was created

Changes

  • 7b1c33d6c706Revision changes
    • breaking

      removed subschema #2 subschema #3 from the request property oneOf list

    • info

      added subschema #2 subschema #3 to the request property oneOf list

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • dce5621fe589Revision changes
    • breaking

      removed subschema #2 subschema #3 from the request property oneOf list

    • info

      added subschema #2 subschema #3 to the request property oneOf list