> ## Documentation Index > Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a checkout link > 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. **Required scope** * `write:creator` — Modify creator profiles, settings, and creator-specific data. ## OpenAPI ````yaml /openapi.json post /checkout-links openapi: 3.1.0 info: title: Fanvue API version: '0.1' servers: [] security: [] paths: /checkout-links: post: summary: Create a checkout link description: >- 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. operationId: createCheckoutLink parameters: - $ref: '#/components/parameters/ApiVersionHeader' requestBody: content: application/json: schema: type: object properties: description: type: string maxLength: 500 description: >- Internal note shown only in the creator dashboard. Fans never see it. redirectUrl: type: string format: uri description: URL fans are redirected to after a successful purchase. source: oneOf: - type: object properties: kind: type: string enum: - existing_price description: Sell an existing product price through the new link. productPriceUuid: type: string format: uuid description: UUID of the existing product price to sell. required: - kind - productPriceUuid - type: object properties: kind: type: string enum: - existing_product description: >- Mint a new price on an existing product and sell it through the new link. productUuid: type: string format: uuid description: UUID of the existing product to price. price: type: object properties: amount: type: integer description: >- Price in integer minor units of the currency (e.g. cents: 1999 = $19.99). 0 creates a free link; paid links must be between 300 and 250000 minor units ($3-$2500). Note: the Fanvue dashboard displays prices in major units; this API always uses integer minor units. currency: type: string minLength: 3 maxLength: 3 pattern: ^[A-Z]{3}$ default: USD description: >- 3-letter uppercase ISO-4217 currency code. Defaults to USD. isRecurring: type: boolean description: >- Whether purchases bill on a recurring cycle (subscription) or once. Recurring prices require a non-zero amount plus cycleLength and cycleUnit. cycleLength: type: integer exclusiveMinimum: 0 description: >- Billing cycle length. Required (with cycleUnit) when isRecurring is true. cycleUnit: type: string enum: - day - week - month - year description: >- Billing cycle unit. Required (with cycleLength) when isRecurring is true. required: - amount - isRecurring required: - kind - productUuid - price - type: object properties: kind: type: string enum: - new_product description: >- Create a brand-new product with a price and sell it through the new link. product: type: object properties: name: type: string minLength: 1 maxLength: 100 description: >- Product name. Must be unique (case-insensitive) among the creator's products. description: type: string maxLength: 500 description: Optional product description. required: - name price: type: object properties: amount: type: integer description: >- Price in integer minor units of the currency (e.g. cents: 1999 = $19.99). 0 creates a free link; paid links must be between 300 and 250000 minor units ($3-$2500). Note: the Fanvue dashboard displays prices in major units; this API always uses integer minor units. currency: type: string minLength: 3 maxLength: 3 pattern: ^[A-Z]{3}$ default: USD description: >- 3-letter uppercase ISO-4217 currency code. Defaults to USD. isRecurring: type: boolean description: >- Whether purchases bill on a recurring cycle (subscription) or once. Recurring prices require a non-zero amount plus cycleLength and cycleUnit. cycleLength: type: integer exclusiveMinimum: 0 description: >- Billing cycle length. Required (with cycleUnit) when isRecurring is true. cycleUnit: type: string enum: - day - week - month - year description: >- Billing cycle unit. Required (with cycleLength) when isRecurring is true. required: - amount - isRecurring required: - kind - product - price description: >- 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`). required: - source responses: '201': description: Checkout link created successfully content: application/json: schema: type: object properties: uuid: type: string format: uuid description: Checkout link UUID name: type: string description: >- Creator-internal label for the link (derived from the product name) description: type: - string - 'null' description: >- Creator-internal note (null when unset). Fans never see it. url: type: - string - 'null' description: Shareable checkout URL fans use to purchase price: type: integer description: >- Price in integer minor units of the currency (e.g. cents). 0 for free links. currency: type: string description: ISO-4217 currency code of the price isRecurring: type: boolean description: Whether purchases create a recurring subscription cycleLength: type: - integer - 'null' description: Billing cycle length (null for one-off prices) cycleUnit: type: - string - 'null' enum: - day - week - month - year description: Billing cycle unit (null for one-off prices) productUuid: type: - string - 'null' format: uuid description: UUID of the product the link sells productPriceUuid: type: - string - 'null' format: uuid description: UUID of the product price the link sells status: type: string enum: - active - disabled description: >- active links can be purchased; disabled links reject checkout until re-enabled createdAt: type: string format: date-time description: When the link was created required: - uuid - name - description - url - price - currency - isRecurring - cycleLength - cycleUnit - productUuid - productPriceUuid - status - createdAt example: uuid: b3c4d5e6-7f8a-4b9c-8d0e-1f2a3b4c5d6e name: Coaching call description: Instagram bio link url: https://www.fanvue.com/checkout/fvcl_4WqZz1kXo9DdPp2sT7yRfM price: 1999 currency: USD isRecurring: false cycleLength: null cycleUnit: null productUuid: c4d5e6f7-8a9b-4c0d-9e1f-2a3b4c5d6e7f productPriceUuid: d5e6f7a8-9b0c-4d1e-af2a-3b4c5d6e7f8a status: active createdAt: '2024-01-15T00:00:00.000Z' '400': description: Bad Request - API version not supported OR validation failed content: application/json: schema: oneOf: - $ref: '#/components/schemas/UnsupportedVersionError' - $ref: '#/components/schemas/ValidationError' '401': $ref: '#/components/responses/UnauthorizedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '410': $ref: '#/components/responses/SunsetVersionResponse' '429': $ref: '#/components/responses/RateLimitResponse' security: - BearerAuth: - write:creator components: parameters: ApiVersionHeader: name: X-Fanvue-API-Version in: header required: true schema: type: string default: '2025-06-26' example: '2025-06-26' description: API version to use for the request schemas: UnsupportedVersionError: type: object properties: error: type: string message: type: string required: - error - message description: API version not supported ValidationError: type: object properties: errors: type: array items: type: string required: - errors description: Request validation failed responses: UnauthorizedResponse: description: Unauthorized Response content: application/json: schema: type: object properties: error: type: string required: - error NotFoundResponse: description: Not Found Response content: application/json: schema: type: object properties: message: type: string required: - message SunsetVersionResponse: description: API version no longer supported (sunset) content: application/json: schema: type: object properties: error: type: string message: type: string nextVersion: type: string required: - error - message RateLimitResponse: description: Too many requests - rate limit exceeded headers: Retry-After: description: Number of seconds to wait before retrying the request schema: type: integer X-RateLimit-Limit: description: The maximum number of requests allowed in the current window schema: type: integer X-RateLimit-Remaining: description: The number of requests remaining in the current window schema: type: integer X-RateLimit-Reset: description: The Unix timestamp (seconds) when the rate limit window resets schema: type: integer content: application/json: schema: type: object properties: error: type: string required: - error securitySchemes: BearerAuth: type: oauth2 description: >- 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. flows: authorizationCode: authorizationUrl: https://auth.fanvue.com/oauth2/auth tokenUrl: https://auth.fanvue.com/oauth2/token refreshUrl: https://auth.fanvue.com/oauth2/token scopes: read:self: >- Access your own user profile information, including basic account details and settings. read:chat: >- Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history. write:chat: >- Create new chats and send messages. This scope is required for any chat-related actions that modify data. read:experience: >- Exchange a fan's experience token for the resolved experience and the fan's identity, so an embedded fan-facing experience can render the right content. write:experience: >- Request that the creator publish or unpublish a fan-facing experience. The app mints a request token; the creator confirms and Fanvue performs the change. read:fan: Access fan-related data and information within the platform. read:post: Read posts, including post details, comments, likes, and tips. write:post: Create, edit, and manage posts and content on behalf of users. read:media: Access media files, images, videos, and other content assets. write:media: >- Upload, modify, and manage media files and content assets. Also required for vault folder management. read:creator: >- Access creator profiles, content, and creator-specific information. write:creator: Modify creator profiles, settings, and creator-specific data. read:insights: >- Access analytics, metrics, and insights data for performance tracking. read:tracking_links: >- Read tracking links and the users associated with them, including per-user tracking metadata. write:tracking_links: Create and delete tracking links. read:agency: Read agency information, including the agency's team members. write:agency: >- Manage agency team members and invites, including inviting new team members and creators. ````