> ## 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 subscriber by user UUID > Returns a single subscriber of the authenticated user by their user UUID, including their subscription details. Returns 404 if the user is not a subscriber. **Required scope** * `read:fan` — Access fan-related data and information within the platform. ## OpenAPI ````yaml /openapi.json get /subscribers/{userUuid} openapi: 3.1.0 info: title: Fanvue API version: '0.1' servers: [] security: [] paths: /subscribers/{userUuid}: get: summary: Get subscriber by user UUID description: >- Returns a single subscriber of the authenticated user by their user UUID, including their subscription details. Returns 404 if the user is not a subscriber. operationId: getSubscriber parameters: - $ref: '#/components/parameters/ApiVersionHeader' - schema: type: string format: uuid description: UUID of the subscriber to retrieve required: true description: UUID of the subscriber to retrieve name: userUuid in: path responses: '200': description: Subscriber details content: application/json: schema: type: object properties: uuid: type: string format: uuid handle: type: string displayName: type: string nickname: type: - string - 'null' isTopSpender: type: boolean avatarUrl: type: - string - 'null' registeredAt: type: string format: date-time subscription: type: - object - 'null' properties: status: type: string enum: - active - cancelled - pending_confirmation - paused description: >- Current status of the subscriber's subscription to this creator price: type: number description: >- Configured subscription price per period, in minor currency units (cents). This is the list price and does not reflect discounts or free trials — see `amountPaid` for the actual amount charged. amountPaid: type: number description: >- Amount actually charged for the current period, in minor currency units (cents), after any discount. 0 when nothing has been charged yet (e.g. a fan inside a free trial). currentPeriodStart: type: string format: date-time description: Start of the current subscription period (ISO 8601) currentPeriodEnd: type: - string - 'null' format: date-time description: >- End of the current subscription period / next renewal date (ISO 8601), or null autoRenewalEnabled: type: boolean description: >- Whether the subscription is set to auto-renew (rebill) at the end of the period required: - status - price - amountPaid - currentPeriodStart - currentPeriodEnd - autoRenewalEnabled description: >- Details of the subscriber's current subscription to the creator, or null if none is found firstSubscribedAt: type: - string - 'null' format: date-time description: >- When the fan first subscribed to the creator (earliest across their whole subscription history), used to tell a genuinely new fan from a re-subscriber. Null if unknown. required: - uuid - handle - displayName - nickname - isTopSpender - avatarUrl - registeredAt - subscription - firstSubscribedAt example: uuid: f47ac10b-58cc-4372-a567-0e02b2c3d479 handle: sarah-jones nickname: SarahK displayName: Sarah Jones isTopSpender: true avatarUrl: https://media.fanvue.com/avatars/example-avatar.jpg registeredAt: '2024-01-10T12:00:00.000Z' role: creator subscription: status: active price: 999 currentPeriodStart: '2026-05-15T00:00:00.000Z' currentPeriodEnd: '2026-06-15T00:00:00.000Z' autoRenewalEnabled: true firstSubscribedAt: '2025-11-15T00:00:00.000Z' '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:fan 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. ````