> ## 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. # Get a creator's checkout-link payment by invoice number > Fetch a single checkout-link payment by its Fanvue `invoiceNumber`, scoped to the specified creator. Returns 404 if the payment does not exist or does not belong to this creator. **Required scope** * `read:creator` — Access creator profiles, content, and creator-specific information. ## OpenAPI ````yaml /openapi.json get /creators/{creatorUserUuid}/checkout-links/payments/{invoiceNumber} openapi: 3.1.0 info: title: Fanvue API version: '0.1' servers: [] security: [] paths: /creators/{creatorUserUuid}/checkout-links/payments/{invoiceNumber}: get: summary: Get a creator's checkout-link payment by invoice number description: >- Fetch a single checkout-link payment by its Fanvue `invoiceNumber`, scoped to the specified creator. Returns 404 if the payment does not exist or does not belong to this creator. operationId: getCreatorCheckoutLinkPayment parameters: - $ref: '#/components/parameters/ApiVersionHeader' - schema: type: string format: uuid required: true name: creatorUserUuid in: path - schema: type: string description: Fanvue payment identifier (invoice number). required: true description: Fanvue payment identifier (invoice number). name: invoiceNumber in: path responses: '200': description: The checkout-link payment content: application/json: schema: type: object properties: invoiceNumber: type: string description: >- Fanvue's unique payment identifier. Use this as the idempotency key for fulfilment. status: type: string enum: - pending - succeeded - failed description: Settlement status of the payment. billingReason: type: string enum: - one_time - subscription_initial - subscription_renewal description: >- What the payment was for: a one-off purchase, the first payment of a subscription, or a subscription renewal. Matches the `billing_reason` on the checkout_link.payment.* webhook. clientReferenceId: type: - string - 'null' description: >- The merchant-supplied reference passed at checkout via `?client_reference_id=`. Use it to match the payment to your own order/customer. gross: type: number description: Gross amount the buyer paid, in minor units. net: type: - number - 'null' description: Creator net amount after fees, in minor units. fees: type: object properties: fanvueFee: type: - number - 'null' description: Fanvue fee, in minor units. transactionFee: type: - number - 'null' description: Payment processing fee, in minor units. required: - fanvueFee - transactionFee currency: type: - string - 'null' description: ISO currency code of the amounts. transactionId: type: - string - 'null' description: Payment processor transaction reference. createdAt: type: string format: date-time description: When the payment was created. paidAt: type: - string - 'null' format: date-time description: When the payment settled, if it did. checkoutLink: type: object properties: uuid: type: - string - 'null' description: UUID of the checkout link used. name: type: - string - 'null' description: Name of the checkout link / offer. productUuid: type: - string - 'null' description: UUID of the purchased product. productPriceUuid: type: - string - 'null' description: UUID of the purchased product price. required: - uuid - name - productUuid - productPriceUuid purchaser: type: object properties: uuid: type: - string - 'null' description: UUID of the purchasing Fanvue user. email: type: - string - 'null' description: Email of the purchasing Fanvue user. required: - uuid - email metadata: type: object additionalProperties: {} description: >- Arbitrary merchant metadata passed at checkout via `?metadata[key]=value`. required: - invoiceNumber - status - billingReason - clientReferenceId - gross - net - fees - currency - transactionId - createdAt - paidAt - checkoutLink - purchaser - metadata example: invoiceNumber: FVE-20260619-1234 status: succeeded billingReason: one_time clientReferenceId: order_9f8c gross: 9999 net: 8000 fees: fanvueFee: 1500 transactionFee: 499 currency: USD transactionId: txn_abc123 createdAt: '2026-06-19T08:30:00.000Z' paidAt: '2026-06-19T08:30:05.000Z' checkoutLink: uuid: 0b3c0e4a-1f2d-4c8a-9a1b-3e5f7a9c1d2e name: Premium Coaching productUuid: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d productPriceUuid: 9z8y7x6w-5v4u-3t2s-1r0q-9p8o7n6m5l4k purchaser: uuid: 7c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f email: buyer@example.com metadata: campaign: summer '400': description: >- Bad Request - API version not supported OR validation failed OR invalid UUID content: application/json: schema: oneOf: - $ref: '#/components/schemas/UnsupportedVersionError' - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/InvalidUuidError' '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: - read: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 InvalidUuidError: type: object properties: message: type: string required: - message description: Invalid UUID format provided 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. ````