openapi: 3.0.3
info:
  title: 'OnlyFans API'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://app.onlyfansapi.com'
tags:
  -
    name: 'API Keys'
    description: ''
  -
    name: Account
    description: 'Endpoints for your linked accounts'
  -
    name: 'Analytics - Financial'
    description: 'APIs for retrieving financial analytics data'
  -
    name: 'Analytics - Summary'
    description: 'APIs for retrieving summary analytics data'
  -
    name: Banking
    description: 'Operations related to user banking details, payout methods, legal and tax information, and account country settings.'
  -
    name: Chargebacks
    description: ''
  -
    name: 'Chat Messages'
    description: ''
  -
    name: Chats
    description: ''
  -
    name: 'Client Sessions'
    description: ''
  -
    name: 'Connect OnlyFans Account'
    description: ''
  -
    name: 'Data Exports'
    description: 'APIs for managing data exports'
  -
    name: 'Engagement / Messages'
    description: ''
  -
    name: Fans
    description: 'APIs for managing OnlyFans fans (subscribers)'
  -
    name: Following
    description: "APIs for managing OnlyFans followings (people you're subscribed to)"
  -
    name: 'Free Trial Links'
    description: 'APIs for managing Free Trial Links'
  -
    name: 'Link Tags'
    description: 'APIs for managing tags on free trial links and tracking links'
  -
    name: 'Mass Messaging'
    description: ''
  -
    name: Media
    description: ''
  -
    name: 'Media Vault'
    description: ''
  -
    name: 'Media Vault Lists'
    description: ''
  -
    name: Notifications
    description: 'Endpoints for managingr account notifications'
  -
    name: Payouts
    description: ''
  -
    name: 'Post Comments'
    description: ''
  -
    name: 'Post Labels'
    description: 'APIs for managing your post labels'
  -
    name: Posts
    description: 'APIs for managing OnlyFans posts'
  -
    name: Promotions
    description: ''
  -
    name: 'Public Profiles'
    description: ''
  -
    name: Queue
    description: ''
  -
    name: 'Release Forms'
    description: 'APIs for managing OnlyFans release forms'
  -
    name: 'Saved For Later (Messages)'
    description: ''
  -
    name: 'Saved For Later (Posts)'
    description: ''
  -
    name: Settings
    description: ''
  -
    name: 'Smart Links'
    description: 'APIs for managing Smart Links (Free Trial Links and Tracking Links with pooled inventory)'
  -
    name: Statistics
    description: ''
  -
    name: Stories
    description: 'APIs for managing OnlyFans stories'
  -
    name: 'Story Highlights'
    description: 'APIs for managing OnlyFans story highlights'
  -
    name: 'Subscription Bundles'
    description: ''
  -
    name: 'Tracking Links'
    description: 'APIs for managing tracking links'
  -
    name: Transactions
    description: 'APIs for managing OnlyFans transactions'
  -
    name: 'User List Collections'
    description: ''
  -
    name: Users
    description: 'APIs for fetching OnlyFans users'
  -
    name: Webhooks
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'Get your API Key from OnlyFansAPI Console - https://app.onlyfansapi.com/api-keys'
security:
  -
    default: []
paths:
  /api/whoami:
    get:
      summary: Whoami
      operationId: whoami
      description: 'Get details about the currently used API Key & the relevant Team'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  api_key:
                    name: Onboarding
                    last_used_at: '2025-05-23T15:51:52.000000Z'
                    created_at: '2025-04-20T16:27:45.000000Z'
                  team:
                    name: 'Personal Team'
                    slug: personal-team-123
                properties:
                  api_key:
                    type: object
                    properties:
                      name:
                        type: string
                        example: Onboarding
                      last_used_at:
                        type: string
                        example: '2025-05-23T15:51:52.000000Z'
                      created_at:
                        type: string
                        example: '2025-04-20T16:27:45.000000Z'
                  team:
                    type: object
                    properties:
                      name:
                        type: string
                        example: 'Personal Team'
                      slug:
                        type: string
                        example: personal-team-123
      tags:
        - 'API Keys'
  /api/accounts:
    get:
      summary: 'List Accounts'
      operationId: listAccounts
      description: 'List all connected OnlyFans accounts.'
      parameters:
        -
          in: query
          name: onlyfans_id
          description: 'Optionally, filter by the OnlyFans ID'
          example: 1234567890
          required: false
          schema:
            type: string
            description: 'Optionally, filter by the OnlyFans ID'
            example: 1234567890
            nullable: true
        -
          in: query
          name: onlyfans_username
          description: 'Optionally, filter by the OnlyFans username'
          example: username
          required: false
          schema:
            type: string
            description: 'Optionally, filter by the OnlyFans username'
            example: username
            nullable: true
        -
          in: query
          name: onlyfans_email
          description: 'Optionally, filter by the OnlyFans email'
          example: creator@example.com
          required: false
          schema:
            type: string
            description: 'Optionally, filter by the OnlyFans email'
            example: creator@example.com
            nullable: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      example: acct_123
                    onlyfans_id:
                      type: integer
                      example: 123
                    onlyfans_username:
                      type: string
                      example: user
                    onlyfans_email:
                      type: string
                      example: user@example.com
                    is_authenticated:
                      type: boolean
                      example: true
                    authentication_progress:
                      type: string
                      example: signed_in
                    display_name:
                      type: string
                      example: oft
                    onlyfans_user_data:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        ip:
                          type: string
                          example: 127.0.0.1
                        csrf:
                          type: string
                          example: csrf
                        name:
                          type: string
                          example: Name
                        view:
                          type: string
                          example: f
                        about:
                          type: string
                          example: '<p>about</p>'
                        email:
                          type: string
                          example: user@example.com
                        wsUrl:
                          type: string
                          example: 'wss://ws2.onlyfans.com/ws3/03'
                        avatar:
                          type: string
                          example: 'https://example.com'
                        header:
                          type: string
                          example: 'https://example.com'
                        isAuth:
                          type: boolean
                          example: true
                        ivFlow:
                          type: string
                          example: default
                        upload:
                          type: object
                          properties:
                            geoUploadArgs:
                              type: object
                              properties:
                                preset:
                                  type: string
                                  example: of_beta
                                isDelay:
                                  type: boolean
                                  example: true
                                additional:
                                  type: object
                                  properties:
                                    user:
                                      type: string
                                      example: '123'
                                needThumbs:
                                  type: boolean
                                  example: true
                                preset_png:
                                  type: string
                                  example: of_png
                                protected_preset:
                                  type: string
                                  example: of_drm
                        canChat:
                          type: boolean
                          example: true
                        hasTags:
                          type: boolean
                          example: false
                        website:
                          type: string
                          example: null
                        advBlock:
                          type: array
                          example:
                            - subscribe_offers
                          items:
                            type: string
                        ivStatus:
                          type: string
                          example: approved
                        joinDate:
                          type: string
                          example: '2025-04-05T00:00:00+00:00'
                        lastSeen:
                          type: string
                          example: '2025-05-16T10:09:48+00:00'
                        location:
                          type: string
                          example: null
                        paidFeed:
                          type: boolean
                          example: false
                        username:
                          type: string
                          example: user
                        wishlist:
                          type: string
                          example: null
                        hasLabels:
                          type: boolean
                          example: false
                        ivCountry:
                          type: string
                          example: US
                        canAddCard:
                          type: boolean
                          example: true
                        canPinPost:
                          type: boolean
                          example: true
                        creditsMax:
                          type: integer
                          example: 200
                        creditsMin:
                          type: integer
                          example: 10
                        headerSize:
                          type: object
                          properties:
                            width:
                              type: integer
                              example: 2126
                            height:
                              type: integer
                              example: 1535
                        isVerified:
                          type: boolean
                          example: false
                        postsCount:
                          type: integer
                          example: 0
                        audiosCount:
                          type: integer
                          example: 0
                        hasNewHints:
                          type: boolean
                          example: true
                        hasScenario:
                          type: boolean
                          example: true
                        isPerformer:
                          type: boolean
                          example: false
                        mediasCount:
                          type: integer
                          example: 0
                        photosCount:
                          type: integer
                          example: 0
                        videosCount:
                          type: integer
                          example: 0
                        wsAuthToken:
                          type: string
                          example: wsAuthToken
                        avatarThumbs:
                          type: object
                          properties:
                            c50:
                              type: string
                              example: 'https://example.com'
                            c144:
                              type: string
                              example: 'https://example.com'
                        canLookStory:
                          type: boolean
                          example: true
                        hasNewAlerts:
                          type: boolean
                          example: false
                        headerThumbs:
                          type: object
                          properties:
                            w480:
                              type: string
                              example: 'https://example.com'
                            w760:
                              type: string
                              example: 'https://example.com'
                        isOtpEnabled:
                          type: boolean
                          example: true
                        ivFailReason:
                          type: string
                          example: null
                        newTagsCount:
                          type: integer
                          example: 0
                        creditBalance:
                          type: integer
                          example: 0
                        faceIdRegular:
                          type: array
                          example: []
                        isAgeVerified:
                          type: boolean
                          example: false
                        isAllowTweets:
                          type: boolean
                          example: false
                        isMakePayment:
                          type: boolean
                          example: false
                        needIVApprove:
                          type: boolean
                          example: false
                        watermarkText:
                          type: string
                          example: OnlyFans.com/user
                        canCreateLists:
                          type: boolean
                          example: true
                        canPayInternal:
                          type: boolean
                          example: true
                        favoritedCount:
                          type: integer
                          example: 0
                        favoritesCount:
                          type: integer
                          example: 0
                        hasPinnedPosts:
                          type: boolean
                          example: false
                        isEmailChecked:
                          type: boolean
                          example: true
                        isWantComments:
                          type: boolean
                          example: true
                        canCommentStory:
                          type: boolean
                          example: true
                        countPinnedChat:
                          type: integer
                          example: 0
                        isEmailRequired:
                          type: boolean
                          example: false
                        isPaywallPassed:
                          type: boolean
                          example: true
                        isRealPerformer:
                          type: boolean
                          example: false
                        isVisibleOnline:
                          type: boolean
                          example: true
                        showPostsInFeed:
                          type: boolean
                          example: true
                        subscribesCount:
                          type: integer
                          example: 123
                        twitterUsername:
                          type: string
                          example: user
                        canSendChatToAll:
                          type: boolean
                          example: false
                        isCreditsEnabled:
                          type: boolean
                          example: true
                        pinnedPostsCount:
                          type: integer
                          example: 0
                        subscribersCount:
                          type: integer
                          example: 123
                        chatMessagesCount:
                          type: integer
                          example: 123
                        countPriorityChat:
                          type: integer
                          example: 123
                        hasNotViewedStory:
                          type: boolean
                          example: false
                        hasPurchasedPosts:
                          type: boolean
                          example: false
                        hasWatermarkPhoto:
                          type: boolean
                          example: true
                        hasWatermarkVideo:
                          type: boolean
                          example: true
                        isDeleteInitiated:
                          type: boolean
                          example: false
                        isReferrerAllowed:
                          type: boolean
                          example: false
                        watermarkPosition:
                          type: string
                          example: bottom_right
                        archivedPostsCount:
                          type: integer
                          example: 0
                        isSpotifyConnected:
                          type: boolean
                          example: false
                        isTwitterConnected:
                          type: boolean
                          example: false
                        notificationsCount:
                          type: integer
                          example: 123
                        walletFirstRebills:
                          type: boolean
                          example: false
                        canConnectOfAccount:
                          type: boolean
                          example: true
                        connectedOfAccounts:
                          type: array
                          example: []
                        hasInternalPayments:
                          type: boolean
                          example: false
                        hasNewTicketReplies:
                          type: object
                          properties:
                            open:
                              type: boolean
                              example: false
                            closed:
                              type: boolean
                              example: false
                            solved:
                              type: boolean
                              example: false
                        isRealCardConnected:
                          type: boolean
                          example: true
                        maxPinnedPostsCount:
                          type: integer
                          example: 5
                        isWalletAutorecharge:
                          type: boolean
                          example: false
                        canReceiveChatMessage:
                          type: boolean
                          example: false
                        walletAutorechargeMin:
                          type: integer
                          example: 0
                        hasSystemNotifications:
                          type: boolean
                          example: false
                        isLegalApprovedAllowed:
                          type: boolean
                          example: true
                        isPaymentCardConnected:
                          type: boolean
                          example: true
                        ageVerificationRequired:
                          type: boolean
                          example: false
                        payoutLegalApproveState:
                          type: string
                          example: rejected
                        walletAutorechargeAmount:
                          type: integer
                          example: 0
                        canAlternativeWalletTopUp:
                          type: boolean
                          example: false
                        enabledImageEditorForChat:
                          type: boolean
                          example: true
                        privateArchivedPostsCount:
                          type: integer
                          example: 0
                        isMarkdownDisabledForAbout:
                          type: boolean
                          example: true
                        avatarHeaderConverterUpload:
                          type: boolean
                          example: true
                        hasNewChangedPriceSubscriptions:
                          type: boolean
                          example: false
                example:
                  -
                    id: acct_123
                    onlyfans_id: 123
                    onlyfans_username: user
                    onlyfans_email: user@example.com
                    is_authenticated: true
                    authentication_progress: signed_in
                    display_name: oft
                    onlyfans_user_data:
                      id: 123
                      ip: 127.0.0.1
                      csrf: csrf
                      name: Name
                      view: f
                      about: '<p>about</p>'
                      email: user@example.com
                      wsUrl: 'wss://ws2.onlyfans.com/ws3/03'
                      avatar: 'https://example.com'
                      header: 'https://example.com'
                      isAuth: true
                      ivFlow: default
                      upload:
                        geoUploadArgs:
                          preset: of_beta
                          isDelay: true
                          additional:
                            user: '123'
                          needThumbs: true
                          preset_png: of_png
                          protected_preset: of_drm
                      canChat: true
                      hasTags: false
                      website: null
                      advBlock:
                        - subscribe_offers
                      ivStatus: approved
                      joinDate: '2025-04-05T00:00:00+00:00'
                      lastSeen: '2025-05-16T10:09:48+00:00'
                      location: null
                      paidFeed: false
                      username: user
                      wishlist: null
                      hasLabels: false
                      ivCountry: US
                      canAddCard: true
                      canPinPost: true
                      creditsMax: 200
                      creditsMin: 10
                      headerSize:
                        width: 2126
                        height: 1535
                      isVerified: false
                      postsCount: 0
                      audiosCount: 0
                      hasNewHints: true
                      hasScenario: true
                      isPerformer: false
                      mediasCount: 0
                      photosCount: 0
                      videosCount: 0
                      wsAuthToken: wsAuthToken
                      avatarThumbs:
                        c50: 'https://example.com'
                        c144: 'https://example.com'
                      canLookStory: true
                      hasNewAlerts: false
                      headerThumbs:
                        w480: 'https://example.com'
                        w760: 'https://example.com'
                      isOtpEnabled: true
                      ivFailReason: null
                      newTagsCount: 0
                      creditBalance: 0
                      faceIdRegular: []
                      isAgeVerified: false
                      isAllowTweets: false
                      isMakePayment: false
                      needIVApprove: false
                      watermarkText: OnlyFans.com/user
                      canCreateLists: true
                      canPayInternal: true
                      favoritedCount: 0
                      favoritesCount: 0
                      hasPinnedPosts: false
                      isEmailChecked: true
                      isWantComments: true
                      canCommentStory: true
                      countPinnedChat: 0
                      isEmailRequired: false
                      isPaywallPassed: true
                      isRealPerformer: false
                      isVisibleOnline: true
                      showPostsInFeed: true
                      subscribesCount: 123
                      twitterUsername: user
                      canSendChatToAll: false
                      isCreditsEnabled: true
                      pinnedPostsCount: 0
                      subscribersCount: 123
                      chatMessagesCount: 123
                      countPriorityChat: 123
                      hasNotViewedStory: false
                      hasPurchasedPosts: false
                      hasWatermarkPhoto: true
                      hasWatermarkVideo: true
                      isDeleteInitiated: false
                      isReferrerAllowed: false
                      watermarkPosition: bottom_right
                      archivedPostsCount: 0
                      isSpotifyConnected: false
                      isTwitterConnected: false
                      notificationsCount: 123
                      walletFirstRebills: false
                      canConnectOfAccount: true
                      connectedOfAccounts: []
                      hasInternalPayments: false
                      hasNewTicketReplies:
                        open: false
                        closed: false
                        solved: false
                      isRealCardConnected: true
                      maxPinnedPostsCount: 5
                      isWalletAutorecharge: false
                      canReceiveChatMessage: false
                      walletAutorechargeMin: 0
                      hasSystemNotifications: false
                      isLegalApprovedAllowed: true
                      isPaymentCardConnected: true
                      ageVerificationRequired: false
                      payoutLegalApproveState: rejected
                      walletAutorechargeAmount: 0
                      canAlternativeWalletTopUp: false
                      enabledImageEditorForChat: true
                      privateArchivedPostsCount: 0
                      isMarkdownDisabledForAbout: true
                      avatarHeaderConverterUpload: true
                      hasNewChangedPriceSubscriptions: false
      tags:
        - Account
  '/api/accounts/{id}':
    delete:
      summary: 'Disconnect Account'
      operationId: disconnectAccount
      description: 'Disconnect an OnlyFans account.'
      parameters: []
      responses:
        204:
          description: Success
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Account
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the account.'
        example: ipsum
        required: true
        schema:
          type: string
  '/api/{account}/me':
    get:
      summary: 'Get Current Account'
      operationId: getCurrentAccount
      description: 'Get OnlyFans Profile details for the currently used Account'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    isAuth: true
                    ip: 127.0.0.1
                    csrf: csrf_token
                    upload:
                      geoUploadArgs:
                        preset: of_beta
                        protected_preset: of_drm
                        preset_png: of_png
                        isDelay: true
                        needThumbs: true
                        additional:
                          user: '123'
                    avatar: 'https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg'
                    header: 'https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg'
                    headerSize:
                      width: 760
                      height: 570
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg'
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: false
                    subscribePrice: 0
                    hasStripe: false
                    isStripeExist: false
                    subscriptionBundles: []
                    canSendChatToAll: true
                    creditsMin: 10
                    creditsMax: 200
                    isPaywallPassed: true
                    canCreateLists: true
                    joinDate: '2025-01-01T00:00:00+00:00'
                    isReferrerAllowed: true
                    about: ''
                    isMarkdownDisabledForAbout: true
                    website: 'https://onlyfans.com'
                    wishlist: null
                    location: null
                    postsCount: 2
                    archivedPostsCount: 0
                    privateArchivedPostsCount: 0
                    photosCount: 0
                    videosCount: 0
                    audiosCount: 0
                    mediasCount: 0
                    lastSeen: '2025-01-01T00:00:00+00:00'
                    favoritesCount: 0
                    favoritedCount: 0
                    showPostsInFeed: true
                    canReceiveChatMessage: false
                    isPerformer: true
                    isRealPerformer: false
                    isSpotifyConnected: false
                    subscribersCount: 2
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    newTagsCount: 0
                    hasTags: false
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData: null
                    subscribedOnData: null
                    canCreatePromotion: false
                    canCreateTrial: false
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    firstPublishedPostDate: '2025-01-01T00:00:00+00:00'
                    isSpringConnected: false
                    hasNewTicketReplies:
                      open: false
                      solved: false
                      closed: false
                      appeal_form: false
                    hasInternalPayments: false
                    isCreditsEnabled: true
                    creditBalance: 0
                    isMakePayment: false
                    isAgeVerified: false
                    ageVerificationRequired: false
                    isOtpEnabled: true
                    email: user@example.com
                    isEmailChecked: true
                    isLegalApprovedAllowed: true
                    isTwitterConnected: false
                    twitterUsername: TwitterUsername
                    isAllowTweets: false
                    isPaymentCardConnected: true
                    isVisibleOnline: true
                    subscribesCount: 61
                    canPinPost: true
                    hasNewAlerts: false
                    hasNewHints: true
                    hasNewChangedPriceSubscriptions: true
                    notificationsCount: 4
                    hasSystemNotifications: false
                    chatMessagesCount: 57
                    countPinnedChat: 0
                    isWantComments: true
                    watermarkText: OnlyFans.com/username
                    hasWatermarkPhoto: true
                    hasWatermarkVideo: true
                    watermarkPosition: bottom_right
                    advBlock:
                      - banners
                    hasPurchasedPosts: false
                    isEmailRequired: false
                    payoutLegalApproveState: approved
                    enabledImageEditorForChat: true
                    paidFeed: false
                    isRealCardConnected: true
                    countPriorityChat: 35
                    hasScenario: false
                    wsUrl: 'wss://ws2.onlyfans.com/ws3/03'
                    wsAuthToken: ws_auth_token
                    canAddCard: true
                    unreadTips: 0
                    isWalletAutorecharge: false
                    walletAutorechargeAmount: 0
                    walletAutorechargeMin: 0
                    walletFirstRebills: false
                    canAlternativeWalletTopUp: false
                    needIVApprove: false
                    ivStatus: approved
                    ivFailReason: null
                    ivCountry: US
                    ivFlow: default
                    faceIdRegular: []
                    isVerifiedReason: false
                    canReceiveManualPayout: true
                    canReceiveStripePayout: false
                    isNeedConfirmPayout: false
                    canStreaming: false
                    isScheduledStreamsAllowed: false
                    canMakeExpirePosts: true
                    trialMaxDays: 7
                    trialMaxExpiresDays: 30
                    messageMinPrice: 3
                    messageMaxPrice: 100
                    postMinPrice: 3
                    postMaxPrice: 100
                    subscribeMinPrice: 4.99
                    subscribeMaxPrice: 50
                    canAddStory: true
                    canCreateFundRaising: true
                    minFundRaisingTarget: 10
                    maxFundRaisingTarget: 10000
                    ivHideForPerformers: false
                    canChangeContentPrice: true
                    payoutType: bank_ebics_sepa
                    isVatRequired: false
                    isCountryVatRefundable: false
                    isCountryVatNumberCollect: false
                    vatNumberName: VAT
                    isCountryWithVat: false
                    connectedOfAccounts: []
                    canConnectOfAccount: true
                    pinnedPostsCount: 1
                    maxPinnedPostsCount: 5
                    isDeleteInitiated: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999841
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      isAuth:
                        type: boolean
                        example: true
                      ip:
                        type: string
                        example: 127.0.0.1
                      csrf:
                        type: string
                        example: csrf_token
                      upload:
                        type: object
                        properties:
                          geoUploadArgs:
                            type: object
                            properties:
                              preset:
                                type: string
                                example: of_beta
                              protected_preset:
                                type: string
                                example: of_drm
                              preset_png:
                                type: string
                                example: of_png
                              isDelay:
                                type: boolean
                                example: true
                              needThumbs:
                                type: boolean
                                example: true
                              additional:
                                type: object
                                properties:
                                  user:
                                    type: string
                                    example: '123'
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 760
                          height:
                            type: integer
                            example: 570
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: false
                      subscribePrice:
                        type: integer
                        example: 0
                      hasStripe:
                        type: boolean
                        example: false
                      isStripeExist:
                        type: boolean
                        example: false
                      subscriptionBundles:
                        type: array
                        example: []
                      canSendChatToAll:
                        type: boolean
                        example: true
                      creditsMin:
                        type: integer
                        example: 10
                      creditsMax:
                        type: integer
                        example: 200
                      isPaywallPassed:
                        type: boolean
                        example: true
                      canCreateLists:
                        type: boolean
                        example: true
                      joinDate:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: ''
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: 'https://onlyfans.com'
                      wishlist:
                        type: string
                        example: null
                      location:
                        type: string
                        example: null
                      postsCount:
                        type: integer
                        example: 2
                      archivedPostsCount:
                        type: integer
                        example: 0
                      privateArchivedPostsCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      videosCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 0
                      lastSeen:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      favoritesCount:
                        type: integer
                        example: 0
                      favoritedCount:
                        type: integer
                        example: 0
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: false
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: false
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: integer
                        example: 2
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      newTagsCount:
                        type: integer
                        example: 0
                      hasTags:
                        type: boolean
                        example: false
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: string
                        example: null
                      subscribedOnData:
                        type: string
                        example: null
                      canCreatePromotion:
                        type: boolean
                        example: false
                      canCreateTrial:
                        type: boolean
                        example: false
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      isSpringConnected:
                        type: boolean
                        example: false
                      hasNewTicketReplies:
                        type: object
                        properties:
                          open:
                            type: boolean
                            example: false
                          solved:
                            type: boolean
                            example: false
                          closed:
                            type: boolean
                            example: false
                          appeal_form:
                            type: boolean
                            example: false
                      hasInternalPayments:
                        type: boolean
                        example: false
                      isCreditsEnabled:
                        type: boolean
                        example: true
                      creditBalance:
                        type: integer
                        example: 0
                      isMakePayment:
                        type: boolean
                        example: false
                      isAgeVerified:
                        type: boolean
                        example: false
                      ageVerificationRequired:
                        type: boolean
                        example: false
                      isOtpEnabled:
                        type: boolean
                        example: true
                      email:
                        type: string
                        example: user@example.com
                      isEmailChecked:
                        type: boolean
                        example: true
                      isLegalApprovedAllowed:
                        type: boolean
                        example: true
                      isTwitterConnected:
                        type: boolean
                        example: false
                      twitterUsername:
                        type: string
                        example: TwitterUsername
                      isAllowTweets:
                        type: boolean
                        example: false
                      isPaymentCardConnected:
                        type: boolean
                        example: true
                      isVisibleOnline:
                        type: boolean
                        example: true
                      subscribesCount:
                        type: integer
                        example: 61
                      canPinPost:
                        type: boolean
                        example: true
                      hasNewAlerts:
                        type: boolean
                        example: false
                      hasNewHints:
                        type: boolean
                        example: true
                      hasNewChangedPriceSubscriptions:
                        type: boolean
                        example: true
                      notificationsCount:
                        type: integer
                        example: 4
                      hasSystemNotifications:
                        type: boolean
                        example: false
                      chatMessagesCount:
                        type: integer
                        example: 57
                      countPinnedChat:
                        type: integer
                        example: 0
                      isWantComments:
                        type: boolean
                        example: true
                      watermarkText:
                        type: string
                        example: OnlyFans.com/username
                      hasWatermarkPhoto:
                        type: boolean
                        example: true
                      hasWatermarkVideo:
                        type: boolean
                        example: true
                      watermarkPosition:
                        type: string
                        example: bottom_right
                      advBlock:
                        type: array
                        example:
                          - banners
                        items:
                          type: string
                      hasPurchasedPosts:
                        type: boolean
                        example: false
                      isEmailRequired:
                        type: boolean
                        example: false
                      payoutLegalApproveState:
                        type: string
                        example: approved
                      enabledImageEditorForChat:
                        type: boolean
                        example: true
                      paidFeed:
                        type: boolean
                        example: false
                      isRealCardConnected:
                        type: boolean
                        example: true
                      countPriorityChat:
                        type: integer
                        example: 35
                      hasScenario:
                        type: boolean
                        example: false
                      wsUrl:
                        type: string
                        example: 'wss://ws2.onlyfans.com/ws3/03'
                      wsAuthToken:
                        type: string
                        example: ws_auth_token
                      canAddCard:
                        type: boolean
                        example: true
                      unreadTips:
                        type: integer
                        example: 0
                      isWalletAutorecharge:
                        type: boolean
                        example: false
                      walletAutorechargeAmount:
                        type: integer
                        example: 0
                      walletAutorechargeMin:
                        type: integer
                        example: 0
                      walletFirstRebills:
                        type: boolean
                        example: false
                      canAlternativeWalletTopUp:
                        type: boolean
                        example: false
                      needIVApprove:
                        type: boolean
                        example: false
                      ivStatus:
                        type: string
                        example: approved
                      ivFailReason:
                        type: string
                        example: null
                      ivCountry:
                        type: string
                        example: US
                      ivFlow:
                        type: string
                        example: default
                      faceIdRegular:
                        type: array
                        example: []
                      isVerifiedReason:
                        type: boolean
                        example: false
                      canReceiveManualPayout:
                        type: boolean
                        example: true
                      canReceiveStripePayout:
                        type: boolean
                        example: false
                      isNeedConfirmPayout:
                        type: boolean
                        example: false
                      canStreaming:
                        type: boolean
                        example: false
                      isScheduledStreamsAllowed:
                        type: boolean
                        example: false
                      canMakeExpirePosts:
                        type: boolean
                        example: true
                      trialMaxDays:
                        type: integer
                        example: 7
                      trialMaxExpiresDays:
                        type: integer
                        example: 30
                      messageMinPrice:
                        type: integer
                        example: 3
                      messageMaxPrice:
                        type: integer
                        example: 100
                      postMinPrice:
                        type: integer
                        example: 3
                      postMaxPrice:
                        type: integer
                        example: 100
                      subscribeMinPrice:
                        type: number
                        example: 4.99
                      subscribeMaxPrice:
                        type: integer
                        example: 50
                      canAddStory:
                        type: boolean
                        example: true
                      canCreateFundRaising:
                        type: boolean
                        example: true
                      minFundRaisingTarget:
                        type: integer
                        example: 10
                      maxFundRaisingTarget:
                        type: integer
                        example: 10000
                      ivHideForPerformers:
                        type: boolean
                        example: false
                      canChangeContentPrice:
                        type: boolean
                        example: true
                      payoutType:
                        type: string
                        example: bank_ebics_sepa
                      isVatRequired:
                        type: boolean
                        example: false
                      isCountryVatRefundable:
                        type: boolean
                        example: false
                      isCountryVatNumberCollect:
                        type: boolean
                        example: false
                      vatNumberName:
                        type: string
                        example: VAT
                      isCountryWithVat:
                        type: boolean
                        example: false
                      connectedOfAccounts:
                        type: array
                        example: []
                      canConnectOfAccount:
                        type: boolean
                        example: true
                      pinnedPostsCount:
                        type: integer
                        example: 1
                      maxPinnedPostsCount:
                        type: integer
                        example: 5
                      isDeleteInitiated:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999841
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Account
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/me/model-start-date':
    get:
      summary: 'Get Model Start Date'
      operationId: getModelStartDate
      description: 'Get the start date of the model (the date+time monetization was enabled)'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    startDate: '2025-01-01 01:01:01'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999841
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      startDate:
                        type: string
                        example: '2025-01-01 01:01:01'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999841
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - Account
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/me/top-percentage':
    get:
      summary: 'Get Top Percentage'
      operationId: getTopPercentage
      description: 'Get the top percentage of the model (e.g., top 0.02% of all creators)'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    top_percentage: 0.02
                    message: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999911
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49912
                properties:
                  data:
                    type: object
                    properties:
                      top_percentage:
                        type: number
                        example: 0.02
                      message:
                        type: string
                        example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999911
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49912
      tags:
        - Account
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  /api/analytics/financial/transactions/summary:
    post:
      summary: 'Get Transaction Summary'
      operationId: getTransactionSummary
      description: 'Get transaction summary including counts for succeeded, refunded, and disputed transactions, plus gross, net, and fee totals.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  succeeded_count: 150
                  refunded_count: 5
                  disputed_count: 2
                  total_gross: 20000.0
                  total_net: 16000.0
                  total_fees: 4000.0
                properties:
                  succeeded_count:
                    type: integer
                    example: 150
                  refunded_count:
                    type: integer
                    example: 5
                  disputed_count:
                    type: integer
                    example: 2
                  total_gross:
                    type: number
                    example: 20000.0
                  total_net:
                    type: number
                    example: 16000.0
                  total_fees:
                    type: number
                    example: 4000.0
      tags:
        - 'Analytics - Financial'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: 'Array of account prefixed IDs'
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                start_date:
                  type: string
                  description: 'The start date (ISO 8601 format)'
                  example: '2024-01-01'
                end_date:
                  type: string
                  description: 'The end date (ISO 8601 format)'
                  example: '2024-12-31'
              required:
                - account_ids
                - start_date
                - end_date
  /api/analytics/financial/transactions/by-type:
    post:
      summary: 'Get Transactions By Type'
      operationId: getTransactionsByType
      description: 'Get transaction totals grouped by transaction type (subscriptions, tips, messages, etc.).'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      example: subscription
                    count:
                      type: integer
                      example: 100
                    total:
                      type: number
                      example: 5000.0
                example:
                  -
                    type: subscription
                    count: 100
                    total: 5000.0
                  -
                    type: tip
                    count: 50
                    total: 2500.0
      tags:
        - 'Analytics - Financial'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: 'Array of account prefixed IDs'
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                start_date:
                  type: string
                  description: 'The start date (ISO 8601 format)'
                  example: '2024-01-01'
                end_date:
                  type: string
                  description: 'The end date (ISO 8601 format)'
                  example: '2024-12-31'
              required:
                - account_ids
                - start_date
                - end_date
  /api/analytics/financial/forecast:
    post:
      summary: 'Get Revenue Forecast'
      operationId: getRevenueForecast
      description: 'Generate revenue or churn forecasts using statistical models (Moving Average, Linear Regression, ARIMA, SARIMA).'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  metric: revenue
                  model: linear_regression
                  historical:
                    -
                      date: '2024-01-01'
                      value: 500.0
                  forecast:
                    -
                      date: '2024-02-01'
                      value: 550.0
                properties:
                  metric:
                    type: string
                    example: revenue
                  model:
                    type: string
                    example: linear_regression
                  historical:
                    type: array
                    example:
                      -
                        date: '2024-01-01'
                        value: 500
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          example: '2024-01-01'
                        value:
                          type: number
                          example: 500.0
                  forecast:
                    type: array
                    example:
                      -
                        date: '2024-02-01'
                        value: 550
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                          example: '2024-02-01'
                        value:
                          type: number
                          example: 550.0
      tags:
        - 'Analytics - Financial'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: 'Array of account prefixed IDs'
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                metric:
                  type: string
                  description: 'The metric to forecast'
                  example: revenue
                  enum:
                    - revenue
                    - churn_percentage
                model:
                  type: string
                  description: 'The forecasting model to use'
                  example: linear_regression
                  enum:
                    - moving_average
                    - linear_regression
                    - arima
                    - sarima
                historical_days:
                  type: integer
                  description: 'Number of historical days to analyze (30-730)'
                  example: 90
                forecast_days:
                  type: integer
                  description: 'Number of days to forecast (7-365)'
                  example: 30
              required:
                - account_ids
                - metric
                - model
                - historical_days
                - forecast_days
  /api/analytics/financial/profitability:
    post:
      summary: 'Get Profitability'
      operationId: getProfitability
      description: 'Calculate profitability for creators including revenue, costs, commissions, and margins for a specific month.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    creator_id:
                      type: integer
                      example: 12345
                    name:
                      type: string
                      example: 'Creator Name'
                    gross_revenue:
                      type: number
                      example: 10000.0
                    net_revenue:
                      type: number
                      example: 8000.0
                    total_costs:
                      type: number
                      example: 500.0
                    commission:
                      type: number
                      example: 1500.0
                    profit:
                      type: number
                      example: 6000.0
                    margin:
                      type: number
                      example: 75.0
                example:
                  -
                    creator_id: 12345
                    name: 'Creator Name'
                    gross_revenue: 10000.0
                    net_revenue: 8000.0
                    total_costs: 500.0
                    commission: 1500.0
                    profit: 6000.0
                    margin: 75.0
      tags:
        - 'Analytics - Financial'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: 'Array of account prefixed IDs'
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                year:
                  type: integer
                  description: 'The year to calculate profitability for'
                  example: 2024
                month:
                  type: integer
                  description: 'The month to calculate profitability for (1-12)'
                  example: 6
              required:
                - account_ids
                - year
                - month
  '/api/analytics/financial/profitability/{account}/history':
    get:
      summary: 'Get Profitability History'
      operationId: getProfitabilityHistory
      description: 'Get historical profitability data for a specific account over multiple months.'
      parameters:
        -
          in: query
          name: months
          description: 'Number of months of history to retrieve (1-60, default 12)'
          example: 12
          required: false
          schema:
            type: integer
            description: 'Number of months of history to retrieve (1-60, default 12)'
            example: 12
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    year:
                      type: integer
                      example: 2024
                    month:
                      type: integer
                      example: 1
                    gross_revenue:
                      type: number
                      example: 10000.0
                    net_revenue:
                      type: number
                      example: 8000.0
                    profit:
                      type: number
                      example: 6000.0
                    margin:
                      type: number
                      example: 75.0
                example:
                  -
                    year: 2024
                    month: 1
                    gross_revenue: 10000.0
                    net_revenue: 8000.0
                    profit: 6000.0
                    margin: 75.0
      tags:
        - 'Analytics - Financial'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_prefixed_id:
                  type: string
                  description: ''
                  example: et
                months:
                  type: integer
                  description: 'Must be at least 1. Must not be greater than 60.'
                  example: 25
              required:
                - account_prefixed_id
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  /api/analytics/summary/earnings:
    post:
      summary: 'Get Earnings Overview'
      operationId: getEarningsOverview
      description: 'Get earnings overview by category for selected accounts within a date range. Returns total earnings, subscriptions, posts, messages, tips, streams, and content stats.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  total_earnings: 15000.5
                  subscriptions: 8000.0
                  posts: 2500.0
                  messages: 3000.0
                  tips_posts: 500.0
                  tips_messages: 800.0
                  streams: 200.5
                  total_accounts: 5
                  total_messages: 1250
                  total_images: 450
                  total_videos: 120
                properties:
                  total_earnings:
                    type: number
                    example: 15000.5
                  subscriptions:
                    type: number
                    example: 8000.0
                  posts:
                    type: number
                    example: 2500.0
                  messages:
                    type: number
                    example: 3000.0
                  tips_posts:
                    type: number
                    example: 500.0
                  tips_messages:
                    type: number
                    example: 800.0
                  streams:
                    type: number
                    example: 200.5
                  total_accounts:
                    type: integer
                    example: 5
                  total_messages:
                    type: integer
                    example: 1250
                  total_images:
                    type: integer
                    example: 450
                  total_videos:
                    type: integer
                    example: 120
      tags:
        - 'Analytics - Summary'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: 'Array of account prefixed IDs to get earnings for'
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                start_date:
                  type: string
                  description: 'The start date (ISO 8601 format)'
                  example: '2024-01-01'
                end_date:
                  type: string
                  description: 'The end date (ISO 8601 format)'
                  example: '2024-12-31'
              required:
                - account_ids
                - start_date
                - end_date
  /api/analytics/summary/historical:
    post:
      summary: 'Get Historical Performance'
      operationId: getHistoricalPerformance
      description: 'Get historical earnings chart data for the team. Returns monthly aggregated revenue data for the specified time range.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    period:
                      type: string
                      example: 2024-01
                    value:
                      type: number
                      example: 5000.0
                example:
                  -
                    period: 2024-01
                    value: 5000.0
                  -
                    period: 2024-02
                    value: 5500.0
      tags:
        - 'Analytics - Summary'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                time_range:
                  type: string
                  description: 'The time range for historical data'
                  example: 12m
                  enum:
                    - 3m
                    - 6m
                    - 12m
                    - ytd
                    - last-year
  /api/analytics/summary/comparison:
    post:
      summary: 'Get Period Comparison'
      operationId: getPeriodComparison
      description: 'Compare two time periods to analyze performance changes. Returns summary, breakdown, and chart data for the comparison.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  summary:
                    period_a_total: 15000.0
                    period_b_total: 18000.0
                    change: 3000.0
                    change_percentage: 20.0
                  breakdown: []
                  chart_data: []
                  period_a_label: 'Q1 2024'
                  period_b_label: 'Q2 2024'
                properties:
                  summary:
                    type: object
                    properties:
                      period_a_total:
                        type: number
                        example: 15000.0
                      period_b_total:
                        type: number
                        example: 18000.0
                      change:
                        type: number
                        example: 3000.0
                      change_percentage:
                        type: number
                        example: 20.0
                  breakdown:
                    type: array
                    example: []
                  chart_data:
                    type: array
                    example: []
                  period_a_label:
                    type: string
                    example: 'Q1 2024'
                  period_b_label:
                    type: string
                    example: 'Q2 2024'
      tags:
        - 'Analytics - Summary'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: 'Array of account prefixed IDs to compare'
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                period_a:
                  type: object
                  description: 'First period to compare'
                  example:
                    start: '2024-01-01'
                    end: '2024-03-31'
                  properties:
                    start:
                      type: string
                      description: 'Must be a valid date.'
                      example: '2026-03-04T17:39:22'
                    end:
                      type: string
                      description: 'Must be a valid date. Must be a date after or equal to <code>period_a.start</code>.'
                      example: '2118-01-03'
                  required:
                    - start
                    - end
                period_b:
                  type: object
                  description: 'Second period to compare'
                  example:
                    start: '2024-04-01'
                    end: '2024-06-30'
                  properties:
                    start:
                      type: string
                      description: 'Must be a valid date.'
                      example: '2026-03-04T17:39:22'
                    end:
                      type: string
                      description: 'Must be a valid date. Must be a date after or equal to <code>period_b.start</code>.'
                      example: '2078-11-25'
                  required:
                    - start
                    - end
                granularity:
                  type: string
                  description: 'Comparison granularity'
                  example: months
                  enum:
                    - months
                    - quarters
                    - half_years
                    - years
                stat_type:
                  type: string
                  description: 'The statistic type to compare'
                  example: totalEarnings
                  enum:
                    - totalEarnings
                    - subscriptions
                    - posts
                    - messages
                    - tipsPosts
                    - tipsMessages
                    - streams
              required:
                - account_ids
                - period_a
                - period_b
  '/api/{account}/banking/details/bank':
    get:
      summary: 'Get Bank Payout Details'
      operationId: getBankPayoutDetails
      description: "Returns the account owner's bank payout details, including whether payout data is filled, available payout methods with their descriptions, and required bank fields."
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isPayoutDataFilled: true
                    payouts:
                      -
                        code: bank_ebics_sepa
                        title: 'International Transfer (SEPA)'
                        subtitle: 'Receive payouts directly to your bank account via SEPA payments'
                        minPayoutSumm: 20
                        payoutTime: '1-3 business days'
                        description: "No limits on number of daily withdrawals (No maximum)\nPayouts are paid directly into your bank account via the SEPA banking system\nAny SEPA bank account"
                        fields:
                          first_name:
                            readonly: true
                            value: '********'
                            label:
                              key: bank_recipient_name_title
                            maxlength: 255
                            oninput:
                              replace:
                                pattern: '[^ a-zA-Z0-9_-]'
                                flag: g
                          last_name:
                            readonly: true
                            value: '********'
                            label:
                              key: bank_recipient_last_name_title
                            maxlength: 255
                            oninput:
                              replace:
                                pattern: '[^ a-zA-Z0-9_-]'
                                flag: g
                          iban:
                            required: true
                            label:
                              key: bank_iban_title
                            regex:
                              pattern: '^[A-Za-z0-9]{1,34}$'
                              flag: g
                            value: '********1234'
                          bic:
                            required: true
                            label:
                              key: bank_bic_swift_title
                            maxlength: 70
                            value: '********'
                          bank_name:
                            required: true
                            label:
                              key: bank_bank_name_title_new
                            maxlength: 70
                            value: 'Bank name'
                          country:
                            label:
                              key: country_label
                            readonly: true
                            uionly: true
                            value: Country
                          address:
                            required: true
                            label:
                              key: bank_user_address_title
                            maxlength: 255
                            value: '********'
                          city:
                            required: true
                            label:
                              key: bank_user_city_title
                            maxlength: 255
                            value: 'City value'
                          postal:
                            required: true
                            label:
                              key: bank_user_postal_zip_title
                            maxlength: 255
                            value: '********'
                        fieldsOrder:
                          - first_name
                          - last_name
                          - iban
                          - bic
                          - bank_name
                          - country
                          - address
                          - city
                          - postal
                        uiMapping:
                          title:
                            key: add_bank_page_title
                          alert:
                            text:
                              key: payout_add_bank_paxum_hint
                            class: info
                          btn_submit:
                            key: save_payout_details_button
                    payoutCode: bank_ebics_sepa
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000006
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49954
                properties:
                  data:
                    type: object
                    properties:
                      isPayoutDataFilled:
                        type: boolean
                        example: true
                      payouts:
                        type: array
                        example:
                          -
                            code: bank_ebics_sepa
                            title: 'International Transfer (SEPA)'
                            subtitle: 'Receive payouts directly to your bank account via SEPA payments'
                            minPayoutSumm: 20
                            payoutTime: '1-3 business days'
                            description: "No limits on number of daily withdrawals (No maximum)\nPayouts are paid directly into your bank account via the SEPA banking system\nAny SEPA bank account"
                            fields:
                              first_name:
                                readonly: true
                                value: '********'
                                label:
                                  key: bank_recipient_name_title
                                maxlength: 255
                                oninput:
                                  replace:
                                    pattern: '[^ a-zA-Z0-9_-]'
                                    flag: g
                              last_name:
                                readonly: true
                                value: '********'
                                label:
                                  key: bank_recipient_last_name_title
                                maxlength: 255
                                oninput:
                                  replace:
                                    pattern: '[^ a-zA-Z0-9_-]'
                                    flag: g
                              iban:
                                required: true
                                label:
                                  key: bank_iban_title
                                regex:
                                  pattern: '^[A-Za-z0-9]{1,34}$'
                                  flag: g
                                value: '********1234'
                              bic:
                                required: true
                                label:
                                  key: bank_bic_swift_title
                                maxlength: 70
                                value: '********'
                              bank_name:
                                required: true
                                label:
                                  key: bank_bank_name_title_new
                                maxlength: 70
                                value: 'Bank name'
                              country:
                                label:
                                  key: country_label
                                readonly: true
                                uionly: true
                                value: Country
                              address:
                                required: true
                                label:
                                  key: bank_user_address_title
                                maxlength: 255
                                value: '********'
                              city:
                                required: true
                                label:
                                  key: bank_user_city_title
                                maxlength: 255
                                value: 'City value'
                              postal:
                                required: true
                                label:
                                  key: bank_user_postal_zip_title
                                maxlength: 255
                                value: '********'
                            fieldsOrder:
                              - first_name
                              - last_name
                              - iban
                              - bic
                              - bank_name
                              - country
                              - address
                              - city
                              - postal
                            uiMapping:
                              title:
                                key: add_bank_page_title
                              alert:
                                text:
                                  key: payout_add_bank_paxum_hint
                                class: info
                              btn_submit:
                                key: save_payout_details_button
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              example: bank_ebics_sepa
                            title:
                              type: string
                              example: 'International Transfer (SEPA)'
                            subtitle:
                              type: string
                              example: 'Receive payouts directly to your bank account via SEPA payments'
                            minPayoutSumm:
                              type: integer
                              example: 20
                            payoutTime:
                              type: string
                              example: '1-3 business days'
                            description:
                              type: string
                              example: "No limits on number of daily withdrawals (No maximum)\nPayouts are paid directly into your bank account via the SEPA banking system\nAny SEPA bank account"
                            fields:
                              type: object
                              properties:
                                first_name:
                                  type: object
                                  properties:
                                    readonly:
                                      type: boolean
                                      example: true
                                    value:
                                      type: string
                                      example: '********'
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: bank_recipient_name_title } }
                                    maxlength:
                                      type: integer
                                      example: 255
                                    oninput:
                                      type: object
                                      properties: { replace: { type: object, properties: { pattern: { type: string, example: '[^ a-zA-Z0-9_-]' }, flag: { type: string, example: g } } } }
                                last_name:
                                  type: object
                                  properties:
                                    readonly:
                                      type: boolean
                                      example: true
                                    value:
                                      type: string
                                      example: '********'
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: bank_recipient_last_name_title } }
                                    maxlength:
                                      type: integer
                                      example: 255
                                    oninput:
                                      type: object
                                      properties: { replace: { type: object, properties: { pattern: { type: string, example: '[^ a-zA-Z0-9_-]' }, flag: { type: string, example: g } } } }
                                iban:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: bank_iban_title } }
                                    regex:
                                      type: object
                                      properties: { pattern: { type: string, example: '^[A-Za-z0-9]{1,34}$' }, flag: { type: string, example: g } }
                                    value:
                                      type: string
                                      example: '********1234'
                                bic:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: bank_bic_swift_title } }
                                    maxlength:
                                      type: integer
                                      example: 70
                                    value:
                                      type: string
                                      example: '********'
                                bank_name:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: bank_bank_name_title_new } }
                                    maxlength:
                                      type: integer
                                      example: 70
                                    value:
                                      type: string
                                      example: 'Bank name'
                                country:
                                  type: object
                                  properties:
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: country_label } }
                                    readonly:
                                      type: boolean
                                      example: true
                                    uionly:
                                      type: boolean
                                      example: true
                                    value:
                                      type: string
                                      example: Country
                                address:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: bank_user_address_title } }
                                    maxlength:
                                      type: integer
                                      example: 255
                                    value:
                                      type: string
                                      example: '********'
                                city:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: bank_user_city_title } }
                                    maxlength:
                                      type: integer
                                      example: 255
                                    value:
                                      type: string
                                      example: 'City value'
                                postal:
                                  type: object
                                  properties:
                                    required:
                                      type: boolean
                                      example: true
                                    label:
                                      type: object
                                      properties: { key: { type: string, example: bank_user_postal_zip_title } }
                                    maxlength:
                                      type: integer
                                      example: 255
                                    value:
                                      type: string
                                      example: '********'
                            fieldsOrder:
                              type: array
                              example:
                                - first_name
                                - last_name
                                - iban
                                - bic
                                - bank_name
                                - country
                                - address
                                - city
                                - postal
                              items:
                                type: string
                            uiMapping:
                              type: object
                              properties:
                                title:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: add_bank_page_title
                                alert:
                                  type: object
                                  properties:
                                    text:
                                      type: object
                                      properties: { key: { type: string, example: payout_add_bank_paxum_hint } }
                                    class:
                                      type: string
                                      example: info
                                btn_submit:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: save_payout_details_button
                      payoutCode:
                        type: string
                        example: bank_ebics_sepa
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000006
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49954
      tags:
        - Banking
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/banking/details/legal-form':
    get:
      summary: 'Get Legal Form Details'
      operationId: getLegalFormDetails
      description: "Returns the account owner's legal form details for banking, including personal or business name, address, social media links, date of birth, and available document types for identity verification."
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    realFirstName: 'first name'
                    realLastName: 'last name'
                    realBusinessName: 'business name'
                    realAddress: '123 Street Name'
                    realCity: 'city name'
                    realState: AA
                    realPostal: '12345'
                    realTwitter: TwitterUsername
                    realInstagram: 'https://www.instagram.com/instagram'
                    privateWebsite: 'https://example.com'
                    dateOfBirth: '2000-01-01T00:00:00+00:00'
                    documentType:
                      values:
                        -
                          code: passport
                          name: Passport
                        -
                          code: id_card
                          name: 'ID Card'
                        -
                          code: drivers_license
                          name: 'Drivers License'
                    isAllowedDL: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000005
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49953
                properties:
                  data:
                    type: object
                    properties:
                      realFirstName:
                        type: string
                        example: 'first name'
                      realLastName:
                        type: string
                        example: 'last name'
                      realBusinessName:
                        type: string
                        example: 'business name'
                      realAddress:
                        type: string
                        example: '123 Street Name'
                      realCity:
                        type: string
                        example: 'city name'
                      realState:
                        type: string
                        example: AA
                      realPostal:
                        type: string
                        example: '12345'
                      realTwitter:
                        type: string
                        example: TwitterUsername
                      realInstagram:
                        type: string
                        example: 'https://www.instagram.com/instagram'
                      privateWebsite:
                        type: string
                        example: 'https://example.com'
                      dateOfBirth:
                        type: string
                        example: '2000-01-01T00:00:00+00:00'
                      documentType:
                        type: object
                        properties:
                          values:
                            type: array
                            example:
                              -
                                code: passport
                                name: Passport
                              -
                                code: id_card
                                name: 'ID Card'
                              -
                                code: drivers_license
                                name: 'Drivers License'
                            items:
                              type: object
                              properties:
                                code:
                                  type: string
                                  example: passport
                                name:
                                  type: string
                                  example: Passport
                      isAllowedDL:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000005
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49953
      tags:
        - Banking
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/banking/details/legal-info':
    get:
      summary: 'Get Legal and Tax Status'
      operationId: getLegalAndTaxStatus
      description: "Returns the account owner's legal and tax status required for banking and payout configuration, including W9 requirements, identity verification status, DAC7 compliance, and tax information."
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isXXX: true
                    isW9Required: true
                    isW9Exist: true
                    needShowEditW9: true
                    isRealIdImage: true
                    canChangePayoutType: true
                    ivStatus: approved
                    ivFailReason: null
                    showIvButton: true
                    canShowLegalForm: true
                    payoutLegalApproveRejectReason: null
                    hideBanking: true
                    DAC7:
                      required: true
                      type: personal
                      state: success
                      error: null
                      countryIds:
                        - 123
                    tax:
                      isBankingDisabled: false
                      countryCode: AA
                      editable: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000004
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49952
                properties:
                  data:
                    type: object
                    properties:
                      isXXX:
                        type: boolean
                        example: true
                      isW9Required:
                        type: boolean
                        example: true
                      isW9Exist:
                        type: boolean
                        example: true
                      needShowEditW9:
                        type: boolean
                        example: true
                      isRealIdImage:
                        type: boolean
                        example: true
                      canChangePayoutType:
                        type: boolean
                        example: true
                      ivStatus:
                        type: string
                        example: approved
                      ivFailReason:
                        type: string
                        example: null
                      showIvButton:
                        type: boolean
                        example: true
                      canShowLegalForm:
                        type: boolean
                        example: true
                      payoutLegalApproveRejectReason:
                        type: string
                        example: null
                      hideBanking:
                        type: boolean
                        example: true
                      DAC7:
                        type: object
                        properties:
                          required:
                            type: boolean
                            example: true
                          type:
                            type: string
                            example: personal
                          state:
                            type: string
                            example: success
                          error:
                            type: string
                            example: null
                          countryIds:
                            type: array
                            example:
                              - 123
                            items:
                              type: integer
                      tax:
                        type: object
                        properties:
                          isBankingDisabled:
                            type: boolean
                            example: false
                          countryCode:
                            type: string
                            example: AA
                          editable:
                            type: boolean
                            example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000004
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49952
      tags:
        - Banking
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/banking/details/dac7-form':
    get:
      summary: 'Get DAC7 Form Details'
      operationId: getDAC7FormDetails
      description: "If available, returns the account owner's DAC7 form information required for tax reporting, including personal details, address, tax identification, country information, and DAC7 status."
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    status: success
                    type: personal
                    firstName: 'FIRST NAME'
                    lastName: 'LAST NAME'
                    address: '123 Address'
                    city: City
                    state: State
                    zip: '1234'
                    countryId: 123
                    taxId: '1234'
                    issuingCountryId: 123
                    vatNumber: '123'
                    DOB: '2000-01-01'
                    cityOfBirth: CityOfBirth
                    countryOfBirthId: 123
                    countryOfResidenceId: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999996
                      remaining_day: 49947
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      type:
                        type: string
                        example: personal
                      firstName:
                        type: string
                        example: 'FIRST NAME'
                      lastName:
                        type: string
                        example: 'LAST NAME'
                      address:
                        type: string
                        example: '123 Address'
                      city:
                        type: string
                        example: City
                      state:
                        type: string
                        example: State
                      zip:
                        type: string
                        example: '1234'
                      countryId:
                        type: integer
                        example: 123
                      taxId:
                        type: string
                        example: '1234'
                      issuingCountryId:
                        type: integer
                        example: 123
                      vatNumber:
                        type: string
                        example: '123'
                      DOB:
                        type: string
                        example: '2000-01-01'
                      cityOfBirth:
                        type: string
                        example: CityOfBirth
                      countryOfBirthId:
                        type: integer
                        example: 123
                      countryOfResidenceId:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999996
                          remaining_day:
                            type: integer
                            example: 49947
      tags:
        - Banking
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/banking/details/account-country':
    get:
      summary: 'Get Account Country Details'
      operationId: getAccountCountryDetails
      description: "Returns the account owner's country details for banking, including country code, name, whether the country has states and zip codes, payout eligibility, and W9 form availability."
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 212
                    code: US
                    name: 'United States of America'
                    hasStates: true
                    hasZip: true
                    canPay: true
                    canHasW9Form: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000008
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49956
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 212
                      code:
                        type: string
                        example: US
                      name:
                        type: string
                        example: 'United States of America'
                      hasStates:
                        type: boolean
                        example: true
                      hasZip:
                        type: boolean
                        example: true
                      canPay:
                        type: boolean
                        example: true
                      canHasW9Form:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000008
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49956
      tags:
        - Banking
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/banking/countries':
    get:
      summary: 'List Countries'
      operationId: listCountries
      description: 'List countries, their internal OnlyFans IDs, and their payment & tax information.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 212
                      code: US
                      name: 'United States of America'
                      hasStates: true
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 211
                      code: GB
                      name: 'United Kingdom'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 1
                      code: AF
                      name: Afghanistan
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 2
                      code: AL
                      name: Albania
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 3
                      code: DZ
                      name: Algeria
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 4
                      code: AS
                      name: 'American Samoa'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 5
                      code: AD
                      name: Andorra
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 6
                      code: AO
                      name: Angola
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 7
                      code: AI
                      name: Anguilla
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 8
                      code: AG
                      name: 'Antigua and Barbuda'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 9
                      code: AR
                      name: Argentina
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 10
                      code: AM
                      name: Armenia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 11
                      code: AW
                      name: Aruba
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 12
                      code: AU
                      name: Australia
                      hasStates: true
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 13
                      code: AT
                      name: Austria
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 14
                      code: AZ
                      name: Azerbaijan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 15
                      code: BS
                      name: Bahamas
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 16
                      code: BH
                      name: Bahrain
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 17
                      code: BD
                      name: Bangladesh
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 18
                      code: BB
                      name: Barbados
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 19
                      code: BY
                      name: Belarus
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 20
                      code: BE
                      name: Belgium
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 21
                      code: BZ
                      name: Belize
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 22
                      code: BJ
                      name: Benin
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 23
                      code: BM
                      name: Bermuda
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 24
                      code: BT
                      name: Bhutan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 25
                      code: BO
                      name: Bolivia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 26
                      code: BA
                      name: 'Bosnia and Herzegovina'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 27
                      code: BW
                      name: Botswana
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 28
                      code: BR
                      name: Brazil
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 29
                      code: VG
                      name: 'British Virgin Islands'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 30
                      code: BN
                      name: Brunei
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 31
                      code: BG
                      name: Bulgaria
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 32
                      code: BF
                      name: 'Burkina Faso'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 33
                      code: BI
                      name: Burundi
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 34
                      code: KH
                      name: Cambodia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 35
                      code: CM
                      name: Cameroon
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 36
                      code: CA
                      name: Canada
                      hasStates: true
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 37
                      code: CV
                      name: 'Cape Verde'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 38
                      code: KY
                      name: 'Cayman Islands'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 39
                      code: CF
                      name: 'Central African Republic'
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 40
                      code: TD
                      name: Chad
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 41
                      code: CL
                      name: Chile
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 42
                      code: CN
                      name: China
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 43
                      code: CX
                      name: 'Christmas Island'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 44
                      code: CO
                      name: Colombia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 45
                      code: KM
                      name: Comoros
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 46
                      code: CK
                      name: 'Cook Islands'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 47
                      code: CR
                      name: 'Costa Rica'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 48
                      code: CI
                      name: "Côte d'Ivoire"
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 49
                      code: HR
                      name: Croatia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 50
                      code: CU
                      name: Cuba
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 51
                      code: CY
                      name: Cyprus
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 52
                      code: CZ
                      name: 'Czech Republic'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 53
                      code: CD
                      name: 'Democratic Republic of the Congo'
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 54
                      code: DK
                      name: Denmark
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 55
                      code: DJ
                      name: Djibouti
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 57
                      code: DM
                      name: Dominica
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 56
                      code: DO
                      name: 'Dominican Republic'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 58
                      code: EC
                      name: Ecuador
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 59
                      code: EG
                      name: Egypt
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 60
                      code: SV
                      name: 'El Salvador'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 61
                      code: GQ
                      name: 'Equatorial Guinea'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 62
                      code: ER
                      name: Eritrea
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 63
                      code: EE
                      name: Estonia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 64
                      code: ET
                      name: Ethiopia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 65
                      code: FK
                      name: 'Falkland Islands'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 66
                      code: FO
                      name: 'Faroe Islands'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 67
                      code: FJ
                      name: Fiji
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 68
                      code: FI
                      name: Finland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 69
                      code: FR
                      name: France
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 70
                      code: PF
                      name: 'French Polynesia'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 71
                      code: GA
                      name: Gabon
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 72
                      code: GM
                      name: Gambia
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 73
                      code: GE
                      name: Georgia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 74
                      code: DE
                      name: Germany
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 75
                      code: GH
                      name: Ghana
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 76
                      code: GI
                      name: Gibraltar
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 77
                      code: GR
                      name: Greece
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 78
                      code: GL
                      name: Greenland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 79
                      code: GD
                      name: Grenada
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 80
                      code: GU
                      name: Guam
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 81
                      code: GT
                      name: Guatemala
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 227
                      code: GG
                      name: Guernsey
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 83
                      code: GN
                      name: Guinea
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 82
                      code: GW
                      name: 'Guinea Bissau'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 84
                      code: GY
                      name: Guyana
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 85
                      code: HT
                      name: Haiti
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 86
                      code: HN
                      name: Honduras
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 87
                      code: HK
                      name: 'Hong Kong'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 88
                      code: HU
                      name: Hungary
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 89
                      code: IS
                      name: Iceland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 90
                      code: IN
                      name: India
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 91
                      code: ID
                      name: Indonesia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 92
                      code: IR
                      name: Iran
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 93
                      code: IQ
                      name: Iraq
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 94
                      code: IE
                      name: Ireland
                      hasStates: true
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 228
                      code: IM
                      name: 'Isle of Man'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 95
                      code: IL
                      name: Israel
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 96
                      code: IT
                      name: Italy
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 97
                      code: JM
                      name: Jamaica
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 98
                      code: JP
                      name: Japan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 225
                      code: JE
                      name: Jersey
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 99
                      code: JO
                      name: Jordan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 100
                      code: KZ
                      name: Kazakhstan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 101
                      code: KE
                      name: Kenya
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 102
                      code: KI
                      name: Kiribati
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 226
                      code: XK
                      name: Kosovo
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 103
                      code: KW
                      name: Kuwait
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 104
                      code: KG
                      name: Kyrgyzstan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 105
                      code: LA
                      name: Laos
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 106
                      code: LV
                      name: Latvia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 107
                      code: LB
                      name: Lebanon
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 108
                      code: LS
                      name: Lesotho
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 109
                      code: LR
                      name: Liberia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 110
                      code: LY
                      name: Libya
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 111
                      code: LI
                      name: Liechtenstein
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 112
                      code: LT
                      name: Lithuania
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 113
                      code: LU
                      name: Luxembourg
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 114
                      code: MO
                      name: Macao
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 115
                      code: MK
                      name: Macedonia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 116
                      code: MG
                      name: Madagascar
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 117
                      code: MW
                      name: Malawi
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 118
                      code: MY
                      name: Malaysia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 119
                      code: MV
                      name: Maldives
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 120
                      code: ML
                      name: Mali
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 121
                      code: MT
                      name: Malta
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 122
                      code: MH
                      name: 'Marshall Islands'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 123
                      code: MQ
                      name: Martinique
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 124
                      code: MR
                      name: Mauritania
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 125
                      code: MU
                      name: Mauritius
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 126
                      code: MX
                      name: Mexico
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 127
                      code: FM
                      name: Micronesia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 128
                      code: MD
                      name: Moldova
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 129
                      code: MC
                      name: Monaco
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 130
                      code: MN
                      name: Mongolia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 224
                      code: ME
                      name: Montenegro
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 131
                      code: MS
                      name: Montserrat
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 132
                      code: MA
                      name: Morocco
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 133
                      code: MZ
                      name: Mozambique
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 134
                      code: MM
                      name: Myanmar
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 135
                      code: NA
                      name: Namibia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 136
                      code: NR
                      name: Nauru
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 137
                      code: NP
                      name: Nepal
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 139
                      code: NL
                      name: Netherlands
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 138
                      code: AN
                      name: 'Netherlands Antilles'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 140
                      code: NZ
                      name: 'New Zealand'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 141
                      code: NI
                      name: Nicaragua
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 143
                      code: NE
                      name: Niger
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 142
                      code: NG
                      name: Nigeria
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 144
                      code: NU
                      name: Niue
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 145
                      code: NF
                      name: 'Norfolk Island'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 146
                      code: KP
                      name: 'North Korea'
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 147
                      code: 'NO'
                      name: Norway
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 148
                      code: OM
                      name: Oman
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 149
                      code: PK
                      name: Pakistan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 150
                      code: PW
                      name: Palau
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 151
                      code: PA
                      name: Panama
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 152
                      code: PG
                      name: 'Papua New Guinea'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 153
                      code: PY
                      name: Paraguay
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 154
                      code: PE
                      name: Peru
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 155
                      code: PH
                      name: Philippines
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 156
                      code: PN
                      name: 'Pitcairn Islands'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 157
                      code: PL
                      name: Poland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 158
                      code: PT
                      name: Portugal
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 159
                      code: PR
                      name: 'Puerto Rico'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 160
                      code: QA
                      name: Qatar
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 161
                      code: CG
                      name: 'Republic of the Congo'
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 162
                      code: RO
                      name: Romania
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 163
                      code: RU
                      name: 'Russian Federation'
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 164
                      code: RW
                      name: Rwanda
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 165
                      code: KN
                      name: 'Saint Kitts and Nevis'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 166
                      code: LC
                      name: 'Saint Lucia'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 167
                      code: PM
                      name: 'Saint Pierre'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 168
                      code: VC
                      name: 'Saint Vincent and the Grenadines'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 169
                      code: WS
                      name: Samoa
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 170
                      code: SM
                      name: 'San Marino'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 171
                      code: ST
                      name: 'Sao Tomé and Príncipe'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 172
                      code: SA
                      name: 'Saudi Arabia'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 173
                      code: SN
                      name: Senegal
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 174
                      code: RS
                      name: Serbia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 175
                      code: SC
                      name: Seychelles
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 176
                      code: SL
                      name: 'Sierra Leone'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 177
                      code: SG
                      name: Singapore
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 178
                      code: SK
                      name: Slovakia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 179
                      code: SI
                      name: Slovenia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 180
                      code: SB
                      name: 'Solomon Islands'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 181
                      code: SO
                      name: Somalia
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 182
                      code: ZA
                      name: 'South Africa'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 183
                      code: GS
                      name: 'South Georgia'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 184
                      code: KR
                      name: 'South Korea'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 186
                      code: ES
                      name: Spain
                      hasStates: true
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 187
                      code: LK
                      name: 'Sri Lanka'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 188
                      code: SD
                      name: Sudan
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 189
                      code: SR
                      name: Suriname
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 190
                      code: SZ
                      name: Swaziland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 191
                      code: SE
                      name: Sweden
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 192
                      code: CH
                      name: Switzerland
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 193
                      code: SY
                      name: Syria
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 194
                      code: TW
                      name: Taiwan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 195
                      code: TJ
                      name: Tajikistan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 196
                      code: TZ
                      name: Tanzania
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 197
                      code: TH
                      name: Thailand
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 198
                      code: TB
                      name: Tibet
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 199
                      code: TL
                      name: Timor-Leste
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 200
                      code: TG
                      name: Togo
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 201
                      code: TO
                      name: Tonga
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 202
                      code: TT
                      name: 'Trinidad and Tobago'
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 203
                      code: TN
                      name: Tunisia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 204
                      code: TR
                      name: Turkey
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 205
                      code: TM
                      name: Turkmenistan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 206
                      code: TC
                      name: 'Turks and Caicos Islands'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 207
                      code: TV
                      name: Tuvalu
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 208
                      code: AE
                      name: UAE
                      hasStates: true
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 209
                      code: UG
                      name: Uganda
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 210
                      code: UA
                      name: Ukraine
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 213
                      code: UY
                      name: Uruguay
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 214
                      code: VI
                      name: 'US Virgin Islands'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 215
                      code: UZ
                      name: Uzbekistan
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 216
                      code: VU
                      name: Vanuatu
                      hasStates: false
                      hasZip: false
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 217
                      code: VA
                      name: 'Vatican City'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 218
                      code: VE
                      name: Venezuela
                      hasStates: false
                      hasZip: true
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 219
                      code: VN
                      name: Vietnam
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 220
                      code: WF
                      name: 'Wallis and Futuna'
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 221
                      code: YE
                      name: Yemen
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                    -
                      id: 222
                      code: ZM
                      name: Zambia
                      hasStates: false
                      hasZip: true
                      canPay: true
                      canHasW9Form: false
                    -
                      id: 223
                      code: ZW
                      name: Zimbabwe
                      hasStates: false
                      hasZip: false
                      canPay: false
                      canHasW9Form: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999997
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49945
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 212
                        code: US
                        name: 'United States of America'
                        hasStates: true
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 211
                        code: GB
                        name: 'United Kingdom'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 1
                        code: AF
                        name: Afghanistan
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 2
                        code: AL
                        name: Albania
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 3
                        code: DZ
                        name: Algeria
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 4
                        code: AS
                        name: 'American Samoa'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 5
                        code: AD
                        name: Andorra
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 6
                        code: AO
                        name: Angola
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 7
                        code: AI
                        name: Anguilla
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 8
                        code: AG
                        name: 'Antigua and Barbuda'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 9
                        code: AR
                        name: Argentina
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 10
                        code: AM
                        name: Armenia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 11
                        code: AW
                        name: Aruba
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 12
                        code: AU
                        name: Australia
                        hasStates: true
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 13
                        code: AT
                        name: Austria
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 14
                        code: AZ
                        name: Azerbaijan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 15
                        code: BS
                        name: Bahamas
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 16
                        code: BH
                        name: Bahrain
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 17
                        code: BD
                        name: Bangladesh
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 18
                        code: BB
                        name: Barbados
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 19
                        code: BY
                        name: Belarus
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 20
                        code: BE
                        name: Belgium
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 21
                        code: BZ
                        name: Belize
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 22
                        code: BJ
                        name: Benin
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 23
                        code: BM
                        name: Bermuda
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 24
                        code: BT
                        name: Bhutan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 25
                        code: BO
                        name: Bolivia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 26
                        code: BA
                        name: 'Bosnia and Herzegovina'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 27
                        code: BW
                        name: Botswana
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 28
                        code: BR
                        name: Brazil
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 29
                        code: VG
                        name: 'British Virgin Islands'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 30
                        code: BN
                        name: Brunei
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 31
                        code: BG
                        name: Bulgaria
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 32
                        code: BF
                        name: 'Burkina Faso'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 33
                        code: BI
                        name: Burundi
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 34
                        code: KH
                        name: Cambodia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 35
                        code: CM
                        name: Cameroon
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 36
                        code: CA
                        name: Canada
                        hasStates: true
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 37
                        code: CV
                        name: 'Cape Verde'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 38
                        code: KY
                        name: 'Cayman Islands'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 39
                        code: CF
                        name: 'Central African Republic'
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 40
                        code: TD
                        name: Chad
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 41
                        code: CL
                        name: Chile
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 42
                        code: CN
                        name: China
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 43
                        code: CX
                        name: 'Christmas Island'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 44
                        code: CO
                        name: Colombia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 45
                        code: KM
                        name: Comoros
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 46
                        code: CK
                        name: 'Cook Islands'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 47
                        code: CR
                        name: 'Costa Rica'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 48
                        code: CI
                        name: "Côte d'Ivoire"
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 49
                        code: HR
                        name: Croatia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 50
                        code: CU
                        name: Cuba
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 51
                        code: CY
                        name: Cyprus
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 52
                        code: CZ
                        name: 'Czech Republic'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 53
                        code: CD
                        name: 'Democratic Republic of the Congo'
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 54
                        code: DK
                        name: Denmark
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 55
                        code: DJ
                        name: Djibouti
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 57
                        code: DM
                        name: Dominica
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 56
                        code: DO
                        name: 'Dominican Republic'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 58
                        code: EC
                        name: Ecuador
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 59
                        code: EG
                        name: Egypt
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 60
                        code: SV
                        name: 'El Salvador'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 61
                        code: GQ
                        name: 'Equatorial Guinea'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 62
                        code: ER
                        name: Eritrea
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 63
                        code: EE
                        name: Estonia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 64
                        code: ET
                        name: Ethiopia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 65
                        code: FK
                        name: 'Falkland Islands'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 66
                        code: FO
                        name: 'Faroe Islands'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 67
                        code: FJ
                        name: Fiji
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 68
                        code: FI
                        name: Finland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 69
                        code: FR
                        name: France
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 70
                        code: PF
                        name: 'French Polynesia'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 71
                        code: GA
                        name: Gabon
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 72
                        code: GM
                        name: Gambia
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 73
                        code: GE
                        name: Georgia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 74
                        code: DE
                        name: Germany
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 75
                        code: GH
                        name: Ghana
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 76
                        code: GI
                        name: Gibraltar
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 77
                        code: GR
                        name: Greece
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 78
                        code: GL
                        name: Greenland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 79
                        code: GD
                        name: Grenada
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 80
                        code: GU
                        name: Guam
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 81
                        code: GT
                        name: Guatemala
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 227
                        code: GG
                        name: Guernsey
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 83
                        code: GN
                        name: Guinea
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 82
                        code: GW
                        name: 'Guinea Bissau'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 84
                        code: GY
                        name: Guyana
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 85
                        code: HT
                        name: Haiti
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 86
                        code: HN
                        name: Honduras
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 87
                        code: HK
                        name: 'Hong Kong'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 88
                        code: HU
                        name: Hungary
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 89
                        code: IS
                        name: Iceland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 90
                        code: IN
                        name: India
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 91
                        code: ID
                        name: Indonesia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 92
                        code: IR
                        name: Iran
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 93
                        code: IQ
                        name: Iraq
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 94
                        code: IE
                        name: Ireland
                        hasStates: true
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 228
                        code: IM
                        name: 'Isle of Man'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 95
                        code: IL
                        name: Israel
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 96
                        code: IT
                        name: Italy
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 97
                        code: JM
                        name: Jamaica
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 98
                        code: JP
                        name: Japan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 225
                        code: JE
                        name: Jersey
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 99
                        code: JO
                        name: Jordan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 100
                        code: KZ
                        name: Kazakhstan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 101
                        code: KE
                        name: Kenya
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 102
                        code: KI
                        name: Kiribati
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 226
                        code: XK
                        name: Kosovo
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 103
                        code: KW
                        name: Kuwait
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 104
                        code: KG
                        name: Kyrgyzstan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 105
                        code: LA
                        name: Laos
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 106
                        code: LV
                        name: Latvia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 107
                        code: LB
                        name: Lebanon
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 108
                        code: LS
                        name: Lesotho
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 109
                        code: LR
                        name: Liberia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 110
                        code: LY
                        name: Libya
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 111
                        code: LI
                        name: Liechtenstein
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 112
                        code: LT
                        name: Lithuania
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 113
                        code: LU
                        name: Luxembourg
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 114
                        code: MO
                        name: Macao
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 115
                        code: MK
                        name: Macedonia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 116
                        code: MG
                        name: Madagascar
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 117
                        code: MW
                        name: Malawi
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 118
                        code: MY
                        name: Malaysia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 119
                        code: MV
                        name: Maldives
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 120
                        code: ML
                        name: Mali
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 121
                        code: MT
                        name: Malta
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 122
                        code: MH
                        name: 'Marshall Islands'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 123
                        code: MQ
                        name: Martinique
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 124
                        code: MR
                        name: Mauritania
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 125
                        code: MU
                        name: Mauritius
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 126
                        code: MX
                        name: Mexico
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 127
                        code: FM
                        name: Micronesia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 128
                        code: MD
                        name: Moldova
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 129
                        code: MC
                        name: Monaco
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 130
                        code: MN
                        name: Mongolia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 224
                        code: ME
                        name: Montenegro
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 131
                        code: MS
                        name: Montserrat
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 132
                        code: MA
                        name: Morocco
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 133
                        code: MZ
                        name: Mozambique
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 134
                        code: MM
                        name: Myanmar
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 135
                        code: NA
                        name: Namibia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 136
                        code: NR
                        name: Nauru
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 137
                        code: NP
                        name: Nepal
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 139
                        code: NL
                        name: Netherlands
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 138
                        code: AN
                        name: 'Netherlands Antilles'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 140
                        code: NZ
                        name: 'New Zealand'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 141
                        code: NI
                        name: Nicaragua
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 143
                        code: NE
                        name: Niger
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 142
                        code: NG
                        name: Nigeria
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 144
                        code: NU
                        name: Niue
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 145
                        code: NF
                        name: 'Norfolk Island'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 146
                        code: KP
                        name: 'North Korea'
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 147
                        code: 'NO'
                        name: Norway
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 148
                        code: OM
                        name: Oman
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 149
                        code: PK
                        name: Pakistan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 150
                        code: PW
                        name: Palau
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 151
                        code: PA
                        name: Panama
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 152
                        code: PG
                        name: 'Papua New Guinea'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 153
                        code: PY
                        name: Paraguay
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 154
                        code: PE
                        name: Peru
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 155
                        code: PH
                        name: Philippines
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 156
                        code: PN
                        name: 'Pitcairn Islands'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 157
                        code: PL
                        name: Poland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 158
                        code: PT
                        name: Portugal
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 159
                        code: PR
                        name: 'Puerto Rico'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 160
                        code: QA
                        name: Qatar
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 161
                        code: CG
                        name: 'Republic of the Congo'
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 162
                        code: RO
                        name: Romania
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 163
                        code: RU
                        name: 'Russian Federation'
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 164
                        code: RW
                        name: Rwanda
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 165
                        code: KN
                        name: 'Saint Kitts and Nevis'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 166
                        code: LC
                        name: 'Saint Lucia'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 167
                        code: PM
                        name: 'Saint Pierre'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 168
                        code: VC
                        name: 'Saint Vincent and the Grenadines'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 169
                        code: WS
                        name: Samoa
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 170
                        code: SM
                        name: 'San Marino'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 171
                        code: ST
                        name: 'Sao Tomé and Príncipe'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 172
                        code: SA
                        name: 'Saudi Arabia'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 173
                        code: SN
                        name: Senegal
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 174
                        code: RS
                        name: Serbia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 175
                        code: SC
                        name: Seychelles
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 176
                        code: SL
                        name: 'Sierra Leone'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 177
                        code: SG
                        name: Singapore
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 178
                        code: SK
                        name: Slovakia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 179
                        code: SI
                        name: Slovenia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 180
                        code: SB
                        name: 'Solomon Islands'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 181
                        code: SO
                        name: Somalia
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 182
                        code: ZA
                        name: 'South Africa'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 183
                        code: GS
                        name: 'South Georgia'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 184
                        code: KR
                        name: 'South Korea'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 186
                        code: ES
                        name: Spain
                        hasStates: true
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 187
                        code: LK
                        name: 'Sri Lanka'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 188
                        code: SD
                        name: Sudan
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 189
                        code: SR
                        name: Suriname
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 190
                        code: SZ
                        name: Swaziland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 191
                        code: SE
                        name: Sweden
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 192
                        code: CH
                        name: Switzerland
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 193
                        code: SY
                        name: Syria
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 194
                        code: TW
                        name: Taiwan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 195
                        code: TJ
                        name: Tajikistan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 196
                        code: TZ
                        name: Tanzania
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 197
                        code: TH
                        name: Thailand
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 198
                        code: TB
                        name: Tibet
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 199
                        code: TL
                        name: Timor-Leste
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 200
                        code: TG
                        name: Togo
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 201
                        code: TO
                        name: Tonga
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 202
                        code: TT
                        name: 'Trinidad and Tobago'
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 203
                        code: TN
                        name: Tunisia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 204
                        code: TR
                        name: Turkey
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 205
                        code: TM
                        name: Turkmenistan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 206
                        code: TC
                        name: 'Turks and Caicos Islands'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 207
                        code: TV
                        name: Tuvalu
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 208
                        code: AE
                        name: UAE
                        hasStates: true
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 209
                        code: UG
                        name: Uganda
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 210
                        code: UA
                        name: Ukraine
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 213
                        code: UY
                        name: Uruguay
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 214
                        code: VI
                        name: 'US Virgin Islands'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 215
                        code: UZ
                        name: Uzbekistan
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 216
                        code: VU
                        name: Vanuatu
                        hasStates: false
                        hasZip: false
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 217
                        code: VA
                        name: 'Vatican City'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 218
                        code: VE
                        name: Venezuela
                        hasStates: false
                        hasZip: true
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 219
                        code: VN
                        name: Vietnam
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 220
                        code: WF
                        name: 'Wallis and Futuna'
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 221
                        code: YE
                        name: Yemen
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                      -
                        id: 222
                        code: ZM
                        name: Zambia
                        hasStates: false
                        hasZip: true
                        canPay: true
                        canHasW9Form: false
                      -
                        id: 223
                        code: ZW
                        name: Zimbabwe
                        hasStates: false
                        hasZip: false
                        canPay: false
                        canHasW9Form: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 212
                        code:
                          type: string
                          example: US
                        name:
                          type: string
                          example: 'United States of America'
                        hasStates:
                          type: boolean
                          example: true
                        hasZip:
                          type: boolean
                          example: true
                        canPay:
                          type: boolean
                          example: true
                        canHasW9Form:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999997
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49945
      tags:
        - Banking
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/banking/available-payout-systems':
    get:
      summary: 'List Available Payout Systems'
      operationId: listAvailablePayoutSystems
      description: 'Returns a list of available payout systems for the account, including details such as payout method codes, titles, descriptions, minimum payout amounts, processing times, and the currently selected payout method.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    payouts:
                      -
                        code: paxum
                        title: 'Paxum (e-wallet)'
                        subtitle: 'Receive payouts to a Paxum wallet'
                        minPayoutSumm: 20
                        payoutTime: '1 business day'
                        description: "No limits on number of daily withdrawals (No maximum)\nWithdraw money from your Paxum wallet either via bank transfer or on to a Paxum Prepaid Mastercard\n<a href=\"https://www.paxum.com/services/receive-payments\">click here</a>"
                        fields: {  }
                        fieldsOrder: []
                        uiMapping: {  }
                      -
                        code: cosmopayment
                        title: 'Cosmo Payment'
                        subtitle: 'Receive payouts directly to your Cosmo Prepaid Mastercard'
                        minPayoutSumm: 20
                        payoutTime: '1 Business day'
                        description: "No limits on number of daily withdrawals (No maximum)\nWithdraw money from your Cosmo Prepaid Mastercard\nFor more information on Cosmo Payment, go to www.cosmopayment.com/getpaid"
                        fields: {  }
                        fieldsOrder: []
                        uiMapping: {  }
                      -
                        code: securionpay
                        title: 'VISA Direct Transfer'
                        subtitle: 'Receive payouts directly to your VISA debit or credit card'
                        minPayoutSumm: 50
                        payoutTime: '1-2 business days'
                        description: 'Payouts are transferred directly to your VISA Credit or VISA Debit card. '
                        fields: {  }
                        fieldsOrder: []
                        uiMapping: {  }
                      -
                        code: bank_ebics_sepa
                        title: 'International Transfer (SEPA)'
                        subtitle: 'Receive payouts directly to your bank account via SEPA payments'
                        minPayoutSumm: 20
                        payoutTime: '1-3 business days'
                        description: "No limits on number of daily withdrawals (No maximum)\nPayouts are paid directly into your bank account via the SEPA banking system\nAny SEPA bank account"
                        fields: {  }
                        fieldsOrder: []
                        uiMapping: {  }
                      -
                        code: skrill
                        title: 'Receive your funds via Skrill'
                        subtitle: 'Receive payouts to your Skrill account'
                        minPayoutSumm: 20
                        payoutTime: '1 business day'
                        description: 'Receive your funds via Skrill'
                        fields: {  }
                        fieldsOrder: []
                        uiMapping: {  }
                    payoutCode: bank_ebics_sepa
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999996
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49944
                properties:
                  data:
                    type: object
                    properties:
                      payouts:
                        type: array
                        example:
                          -
                            code: paxum
                            title: 'Paxum (e-wallet)'
                            subtitle: 'Receive payouts to a Paxum wallet'
                            minPayoutSumm: 20
                            payoutTime: '1 business day'
                            description: "No limits on number of daily withdrawals (No maximum)\nWithdraw money from your Paxum wallet either via bank transfer or on to a Paxum Prepaid Mastercard\n<a href=\"https://www.paxum.com/services/receive-payments\">click here</a>"
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                          -
                            code: cosmopayment
                            title: 'Cosmo Payment'
                            subtitle: 'Receive payouts directly to your Cosmo Prepaid Mastercard'
                            minPayoutSumm: 20
                            payoutTime: '1 Business day'
                            description: "No limits on number of daily withdrawals (No maximum)\nWithdraw money from your Cosmo Prepaid Mastercard\nFor more information on Cosmo Payment, go to www.cosmopayment.com/getpaid"
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                          -
                            code: securionpay
                            title: 'VISA Direct Transfer'
                            subtitle: 'Receive payouts directly to your VISA debit or credit card'
                            minPayoutSumm: 50
                            payoutTime: '1-2 business days'
                            description: 'Payouts are transferred directly to your VISA Credit or VISA Debit card. '
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                          -
                            code: bank_ebics_sepa
                            title: 'International Transfer (SEPA)'
                            subtitle: 'Receive payouts directly to your bank account via SEPA payments'
                            minPayoutSumm: 20
                            payoutTime: '1-3 business days'
                            description: "No limits on number of daily withdrawals (No maximum)\nPayouts are paid directly into your bank account via the SEPA banking system\nAny SEPA bank account"
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                          -
                            code: skrill
                            title: 'Receive your funds via Skrill'
                            subtitle: 'Receive payouts to your Skrill account'
                            minPayoutSumm: 20
                            payoutTime: '1 business day'
                            description: 'Receive your funds via Skrill'
                            fields: []
                            fieldsOrder: []
                            uiMapping: []
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              example: paxum
                            title:
                              type: string
                              example: 'Paxum (e-wallet)'
                            subtitle:
                              type: string
                              example: 'Receive payouts to a Paxum wallet'
                            minPayoutSumm:
                              type: integer
                              example: 20
                            payoutTime:
                              type: string
                              example: '1 business day'
                            description:
                              type: string
                              example: "No limits on number of daily withdrawals (No maximum)\nWithdraw money from your Paxum wallet either via bank transfer or on to a Paxum Prepaid Mastercard\n<a href=\"https://www.paxum.com/services/receive-payments\">click here</a>"
                            fields:
                              type: object
                              properties: {  }
                            fieldsOrder:
                              type: array
                              example: []
                            uiMapping:
                              type: object
                              properties: {  }
                      payoutCode:
                        type: string
                        example: bank_ebics_sepa
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999996
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49944
      tags:
        - Banking
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/chargebacks':
    get:
      summary: 'List Chargebacks'
      operationId: listChargebacks
      description: 'Retrieve a list of chargebacks within a specified date range.'
      parameters:
        -
          in: query
          name: start_date
          description: 'The start date for the chargebacks. Keep empty to get all.'
          example: '2025-01-01 00:00:00'
          required: false
          schema:
            type: string
            description: 'The start date for the chargebacks. Keep empty to get all.'
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: end_date
          description: 'The end date for the chargebacks. Keep empty to get all.'
          example: '2025-03-31 23:59:59'
          required: false
          schema:
            type: string
            description: 'The end date for the chargebacks. Keep empty to get all.'
            example: '2025-03-31 23:59:59'
        -
          in: query
          name: limit
          description: 'Number of chargebacks to return (1-100). Default = 10'
          example: 50
          required: false
          schema:
            type: string
            description: 'Number of chargebacks to return (1-100). Default = 10'
            example: 50
            nullable: true
        -
          in: query
          name: offset
          description: 'Number of chargebacks to skip, used for pagination.'
          example: 0
          required: false
          schema:
            type: string
            description: 'Number of chargebacks to skip, used for pagination.'
            example: 0
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 0
                        createdAt: '2025-01-01T00:00:00+00:00'
                        paymentType: tips
                        payment:
                          amount: 12.34
                          vatAmount: 0
                          taxAmount: 0
                          mediaTaxAmount: 0
                          net: 12.34
                          fee: 5
                          createdAt: '2025-01-01T00:00:00+00:00'
                          currency: USD
                          description: 'Tip from <a href="https://onlyfans.com/username">Name</a>'
                          status: undo
                          user:
                            view: t
                            id: 123
                            name: Name
                            username: username
                            isVerified: false
                            avatar: null
                            avatarThumbs: null
                          payoutPendingDays: 7
                          id: abc123
                    marker: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964322
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 0
                            createdAt: '2025-01-01T00:00:00+00:00'
                            paymentType: tips
                            payment:
                              amount: 12.34
                              vatAmount: 0
                              taxAmount: 0
                              mediaTaxAmount: 0
                              net: 12.34
                              fee: 5
                              createdAt: '2025-01-01T00:00:00+00:00'
                              currency: USD
                              description: 'Tip from <a href="https://onlyfans.com/username">Name</a>'
                              status: undo
                              user:
                                view: t
                                id: 123
                                name: Name
                                username: username
                                isVerified: false
                                avatar: null
                                avatarThumbs: null
                              payoutPendingDays: 7
                              id: abc123
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 0
                            createdAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            paymentType:
                              type: string
                              example: tips
                            payment:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 12.34
                                vatAmount:
                                  type: integer
                                  example: 0
                                taxAmount:
                                  type: integer
                                  example: 0
                                mediaTaxAmount:
                                  type: integer
                                  example: 0
                                net:
                                  type: number
                                  example: 12.34
                                fee:
                                  type: integer
                                  example: 5
                                createdAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                currency:
                                  type: string
                                  example: USD
                                description:
                                  type: string
                                  example: 'Tip from <a href="https://onlyfans.com/username">Name</a>'
                                status:
                                  type: string
                                  example: undo
                                user:
                                  type: object
                                  properties:
                                    view:
                                      type: string
                                      example: t
                                    id:
                                      type: integer
                                      example: 123
                                    name:
                                      type: string
                                      example: Name
                                    username:
                                      type: string
                                      example: username
                                    isVerified:
                                      type: boolean
                                      example: false
                                    avatar:
                                      type: string
                                      example: null
                                    avatarThumbs:
                                      type: string
                                      example: null
                                payoutPendingDays:
                                  type: integer
                                  example: 7
                                id:
                                  type: string
                                  example: abc123
                      marker:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964322
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Chargebacks
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/chargebacks/statistics':
    get:
      summary: 'List Chargeback Statistics'
      operationId: listChargebackStatistics
      description: 'List chargeback counts & amounts per hour, day or month.'
      parameters:
        -
          in: query
          name: start_date
          description: 'The start date for the chargebacks. Keep empty to get all.'
          example: '2025-01-01 00:00:00'
          required: false
          schema:
            type: string
            description: 'The start date for the chargebacks. Keep empty to get all.'
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: end_date
          description: 'The end date for the chargebacks. Keep empty to get all.'
          example: '2025-03-31 23:59:59'
          required: false
          schema:
            type: string
            description: 'The end date for the chargebacks. Keep empty to get all.'
            example: '2025-03-31 23:59:59'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    chartAmount:
                      -
                        date: '2025-01-01T00:00:00+00:00'
                        count: 123.45
                    chartCount:
                      -
                        date: '2025-01-01T00:00:00+00:00'
                        count: 123
                    total: 123.45
                    delta: 100
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964316
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      chartAmount:
                        type: array
                        example:
                          -
                            date: '2025-01-01T00:00:00+00:00'
                            count: 123.45
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            count:
                              type: number
                              example: 123.45
                      chartCount:
                        type: array
                        example:
                          -
                            date: '2025-01-01T00:00:00+00:00'
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            count:
                              type: integer
                              example: 123
                      total:
                        type: number
                        example: 123.45
                      delta:
                        type: integer
                        example: 100
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964316
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Chargebacks
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/chargebacks/ratio':
    get:
      summary: 'Calculate Chargeback Ratio'
      operationId: calculateChargebackRatio
      description: 'The Chargeback Ratio reflects the number of chargebacks compared to the total number of payments as a percentage. Ideally, your Chargeback Ratio should be under 1%.'
      parameters:
        -
          in: query
          name: start_date
          description: 'The start date for the chargeback ratio. Keep empty to get all.'
          example: '2025-01-01 00:00:00'
          required: false
          schema:
            type: string
            description: 'The start date for the chargeback ratio. Keep empty to get all.'
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: end_date
          description: 'The end date for the chargeback ratio. Keep empty to get all.'
          example: '2025-03-31 23:59:59'
          required: false
          schema:
            type: string
            description: 'The end date for the chargeback ratio. Keep empty to get all.'
            example: '2025-03-31 23:59:59'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    chargebacksRatio: 0.08
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964320
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      chargebacksRatio:
                        type: number
                        example: 0.08
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964320
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Chargebacks
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/messages/{message_id}/pin':
    post:
      summary: 'Pin Message'
      operationId: pinMessage
      description: 'Pin a message from a chat.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964357
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964357
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - 'Chat Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
      -
        in: path
        name: message_id
        description: 'The ID of the message to pin'
        example: '123456789'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/messages/{message_id}/unpin':
    delete:
      summary: 'Unpin Message'
      operationId: unpinMessage
      description: 'Unpin a message from a chat.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964356
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49996
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964356
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - 'Chat Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
      -
        in: path
        name: message_id
        description: 'The ID of the message to unpin'
        example: '123456789'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/messages/{message_id}/like':
    post:
      summary: 'Like Message'
      operationId: likeMessage
      description: 'Like a chat message.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    isLiked: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964351
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49991
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      isLiked:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964351
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49991
      tags:
        - 'Chat Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
      -
        in: path
        name: message_id
        description: 'The ID of the message to like'
        example: '123456789'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/messages/{message_id}/unlike':
    delete:
      summary: 'Unlike Message'
      operationId: unlikeMessage
      description: 'Unlike a chat message.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    isLiked: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964348
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      isLiked:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964348
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Chat Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
      -
        in: path
        name: message_id
        description: 'The ID of the message to unlike'
        example: '123456789'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/messages/search':
    get:
      summary: 'Search Chat Messages'
      operationId: searchChatMessages
      description: 'Search messages in a specific chat. Returns a list of message IDs matching the search query.'
      parameters:
        -
          in: query
          name: query
          description: 'The query search in messages'
          example: Hello
          required: true
          schema:
            type: string
            description: 'The query search in messages'
            example: Hello
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - 123
                    - 456
                    - 789
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999892
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49979
                properties:
                  data:
                    type: array
                    example:
                      - 123
                      - 456
                      - 789
                    items:
                      type: integer
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999892
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49979
      tags:
        - 'Chat Messages'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: ''
                  example: perspiciatis
              required:
                - query
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat (usually a fan's OnlyFans User ID)"
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/messages/{message_id}/attach-tags':
    post:
      summary: 'Attach Tags (Release Forms) to Message'
      operationId: attachTagsReleaseFormsToMessage
      description: 'Attach Tags (Release Forms) to a message that has already been sent. Please note, that this is a "sync" operation - for example, if you provide empty `rfTag` it will remove all existing tags already attached to the message.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 9976
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9976
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - 'Chat Messages'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                rfTag:
                  type: string
                  description: 'Array of OnlyFans Creator User IDs to tag in your message'
                  example: null
                rfPartner:
                  type: string
                  description: 'Array of OnlyFans Release Form Partners IDs to tag in your message'
                  example: null
                rfGuest:
                  type: string
                  description: 'Array of OnlyFans Release Form Guest IDs to tag in your message'
                  example: null
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: message_id
        description: 'The ID of the message to attach the release forms to. This can be ONLY a message sent by the creator.'
        example: '123456789'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/messages':
    get:
      summary: 'List Chat Messages'
      operationId: listChatMessages
      description: 'Get messages from a specific chat.'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of messages to return (default = 10, max = 100)'
          example: 10
          required: false
          schema:
            type: string
            description: 'The number of messages to return (default = 10, max = 100)'
            example: 10
        -
          in: query
          name: filter
          description: 'Filter by certain messages. Currently, only pins are filterable.'
          example: pinned
          required: false
          schema:
            type: string
            description: 'Filter by certain messages. Currently, only pins are filterable.'
            example: pinned
            enum:
              - pinned
        -
          in: query
          name: id
          description: 'ID of the last message from previous page. Used for pagination'
          example: 123
          required: false
          schema:
            type: string
            description: 'ID of the last message from previous page. Used for pagination'
            example: 123
        -
          in: query
          name: first_id
          description: 'Include this message ID as the first message in the results. Used to retrieve messages from e.g. the Search Chat Messages endpoint IDs.'
          example: 123
          required: false
          schema:
            type: string
            description: 'Include this message ID as the first message in the results. Used to retrieve messages from e.g. the Search Chat Messages endpoint IDs.'
            example: 123
            nullable: true
        -
          in: query
          name: order
          description: 'Sort order for messages (desc or asc)'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort order for messages (desc or asc)'
            example: desc
        -
          in: query
          name: skip_users
          description: 'Whether to skip user details (all or none)'
          example: all
          required: false
          schema:
            type: string
            description: 'Whether to skip user details (all or none)'
            example: all
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      responseType: message
                      text: '<p>yes lets do it</p>'
                      giphyId: null
                      lockedText: false
                      isFree: true
                      price: 0
                      isMediaReady: true
                      mediaCount: 0
                      media: []
                      previews: []
                      isTip: false
                      isReportedByMe: false
                      isCouplePeopleMedia: false
                      queueId: 12345678901
                      isMarkdownDisabled: true
                      releaseForms: []
                      fromUser:
                        id: 987654321
                        _view: s
                      isFromQueue: false
                      id: 1234567890123
                      isOpened: false
                      isNew: true
                      createdAt: '2025-09-02T21:02:18+00:00'
                      changedAt: '2025-09-02T21:02:18+00:00'
                      cancelSeconds: 86396
                      isLiked: false
                      canPurchase: false
                      canPurchaseReason: free
                      canReport: false
                      canBePinned: true
                      isPinned: false
                      isSentByMe: true
                    -
                      responseType: message
                      text: '<p>Are you ready for video call now ? </p>'
                      giphyId: null
                      lockedText: false
                      isFree: true
                      price: 0
                      isMediaReady: true
                      mediaCount: 1
                      media:
                        -
                          id: 9876543210
                          type: video
                          convertedToVideo: false
                          canView: true
                          hasError: false
                          createdAt: null
                          isReady: true
                          files:
                            full:
                              url: null
                              width: 480
                              height: 848
                              size: 0
                              sources: []
                            thumb:
                              url: 'https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/300x300_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID'
                              width: 300
                              height: 300
                              size: 0
                            preview:
                              url: 'https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/480x848_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID'
                              width: 480
                              height: 848
                              size: 0
                            squarePreview:
                              url: 'https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/960x960_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID'
                              width: 960
                              height: 960
                              size: 0
                            drm:
                              manifest:
                                hls: 'https://cdn3.onlyfans.com/hls/files/ANONYMIZED_PATH/ANONYMIZED_FILENAME.m3u8'
                                dash: 'https://cdn3.onlyfans.com/dash/files/ANONYMIZED_PATH/ANONYMIZED_FILENAME.mpd'
                              signature:
                                hls:
                                  CloudFront-Policy: ANONYMIZED_CLOUDFRONT_POLICY
                                  CloudFront-Signature: ANONYMIZED_CLOUDFRONT_SIGNATURE
                                  CloudFront-Key-Pair-Id: ANONYMIZED_CLOUDFRONT_KEY_PAIR_ID
                                dash:
                                  CloudFront-Policy: ANONYMIZED_CLOUDFRONT_POLICY
                                  CloudFront-Signature: ANONYMIZED_CLOUDFRONT_SIGNATURE
                                  CloudFront-Key-Pair-Id: ANONYMIZED_CLOUDFRONT_KEY_PAIR_ID
                          duration: 9
                          hasCustomPreview: false
                          videoSources:
                            '240': null
                            '720': null
                      previews: []
                      isTip: false
                      isReportedByMe: false
                      isCouplePeopleMedia: false
                      queueId: 12345678902
                      isMarkdownDisabled: true
                      fromUser:
                        id: 123456789
                        _view: s
                      isFromQueue: true
                      canUnsendQueue: true
                      unsendSecondsQueue: 1000000
                      id: 1234567890124
                      isOpened: false
                      isNew: false
                      createdAt: '2025-09-02T20:35:13+00:00'
                      changedAt: '2025-09-02T20:35:13+00:00'
                      cancelSeconds: 85047
                      isLiked: false
                      canPurchase: false
                      canPurchaseReason: free
                      canReport: true
                      canBePinned: true
                      isPinned: false
                      isSentByMe: false
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_ANONYMIZED_ACCOUNT_ID/chats/987654321/messages?order=desc&skip_users=all&id=1234567890125'
                  _meta:
                    _credits:
                      used: 1
                      balance: 224891
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49984
                properties:
                  data:
                    type: array
                    example:
                      -
                        responseType: message
                        text: '<p>yes lets do it</p>'
                        giphyId: null
                        lockedText: false
                        isFree: true
                        price: 0
                        isMediaReady: true
                        mediaCount: 0
                        media: []
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        isCouplePeopleMedia: false
                        queueId: 12345678901
                        isMarkdownDisabled: true
                        releaseForms: []
                        fromUser:
                          id: 987654321
                          _view: s
                        isFromQueue: false
                        id: 1234567890123
                        isOpened: false
                        isNew: true
                        createdAt: '2025-09-02T21:02:18+00:00'
                        changedAt: '2025-09-02T21:02:18+00:00'
                        cancelSeconds: 86396
                        isLiked: false
                        canPurchase: false
                        canPurchaseReason: free
                        canReport: false
                        canBePinned: true
                        isPinned: false
                        isSentByMe: true
                      -
                        responseType: message
                        text: '<p>Are you ready for video call now ? </p>'
                        giphyId: null
                        lockedText: false
                        isFree: true
                        price: 0
                        isMediaReady: true
                        mediaCount: 1
                        media:
                          -
                            id: 9876543210
                            type: video
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: null
                            isReady: true
                            files:
                              full:
                                url: null
                                width: 480
                                height: 848
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/300x300_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/480x848_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID'
                                width: 480
                                height: 848
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/ANONYMIZED_PATH/960x960_ANONYMIZED_FILENAME.jpg?Tag=2&u=987654321&Policy=ANONYMIZED_POLICY&Signature=ANONYMIZED_SIGNATURE&Key-Pair-Id=ANONYMIZED_KEY_PAIR_ID'
                                width: 960
                                height: 960
                                size: 0
                              drm:
                                manifest:
                                  hls: 'https://cdn3.onlyfans.com/hls/files/ANONYMIZED_PATH/ANONYMIZED_FILENAME.m3u8'
                                  dash: 'https://cdn3.onlyfans.com/dash/files/ANONYMIZED_PATH/ANONYMIZED_FILENAME.mpd'
                                signature:
                                  hls:
                                    CloudFront-Policy: ANONYMIZED_CLOUDFRONT_POLICY
                                    CloudFront-Signature: ANONYMIZED_CLOUDFRONT_SIGNATURE
                                    CloudFront-Key-Pair-Id: ANONYMIZED_CLOUDFRONT_KEY_PAIR_ID
                                  dash:
                                    CloudFront-Policy: ANONYMIZED_CLOUDFRONT_POLICY
                                    CloudFront-Signature: ANONYMIZED_CLOUDFRONT_SIGNATURE
                                    CloudFront-Key-Pair-Id: ANONYMIZED_CLOUDFRONT_KEY_PAIR_ID
                            duration: 9
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        isCouplePeopleMedia: false
                        queueId: 12345678902
                        isMarkdownDisabled: true
                        fromUser:
                          id: 123456789
                          _view: s
                        isFromQueue: true
                        canUnsendQueue: true
                        unsendSecondsQueue: 1000000
                        id: 1234567890124
                        isOpened: false
                        isNew: false
                        createdAt: '2025-09-02T20:35:13+00:00'
                        changedAt: '2025-09-02T20:35:13+00:00'
                        cancelSeconds: 85047
                        isLiked: false
                        canPurchase: false
                        canPurchaseReason: free
                        canReport: true
                        canBePinned: true
                        isPinned: false
                        isSentByMe: false
                    items:
                      type: object
                      properties:
                        responseType:
                          type: string
                          example: message
                        text:
                          type: string
                          example: '<p>yes lets do it</p>'
                        giphyId:
                          type: string
                          example: null
                        lockedText:
                          type: boolean
                          example: false
                        isFree:
                          type: boolean
                          example: true
                        price:
                          type: integer
                          example: 0
                        isMediaReady:
                          type: boolean
                          example: true
                        mediaCount:
                          type: integer
                          example: 0
                        media:
                          type: array
                          example: []
                        previews:
                          type: array
                          example: []
                        isTip:
                          type: boolean
                          example: false
                        isReportedByMe:
                          type: boolean
                          example: false
                        isCouplePeopleMedia:
                          type: boolean
                          example: false
                        queueId:
                          type: integer
                          example: 12345678901
                        isMarkdownDisabled:
                          type: boolean
                          example: true
                        releaseForms:
                          type: array
                          example: []
                        fromUser:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 987654321
                            _view:
                              type: string
                              example: s
                        isFromQueue:
                          type: boolean
                          example: false
                        id:
                          type: integer
                          example: 1234567890123
                        isOpened:
                          type: boolean
                          example: false
                        isNew:
                          type: boolean
                          example: true
                        createdAt:
                          type: string
                          example: '2025-09-02T21:02:18+00:00'
                        changedAt:
                          type: string
                          example: '2025-09-02T21:02:18+00:00'
                        cancelSeconds:
                          type: integer
                          example: 86396
                        isLiked:
                          type: boolean
                          example: false
                        canPurchase:
                          type: boolean
                          example: false
                        canPurchaseReason:
                          type: string
                          example: free
                        canReport:
                          type: boolean
                          example: false
                        canBePinned:
                          type: boolean
                          example: true
                        isPinned:
                          type: boolean
                          example: false
                        isSentByMe:
                          type: boolean
                          example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_ANONYMIZED_ACCOUNT_ID/chats/987654321/messages?order=desc&skip_users=all&id=1234567890125'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224891
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49984
      tags:
        - 'Chat Messages'
    post:
      summary: 'Send Message'
      operationId: sendMessage
      description: 'Send a new message to a chat.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    responseType: message
                    text: '<p>Message text</p>'
                    giphyId: null
                    lockedText: true
                    isFree: true
                    price: 0
                    isMediaReady: true
                    mediaCount: 0
                    media: []
                    previews: []
                    isTip: false
                    isReportedByMe: false
                    isCouplePeopleMedia: false
                    queueId: 123
                    isMarkdownDisabled: true
                    releaseForms: []
                    fromUser:
                      id: 339543013
                      _view: s
                    isFromQueue: false
                    id: 123
                    isOpened: false
                    isNew: true
                    createdAt: '2025-02-03T23:29:53+00:00'
                    changedAt: '2025-02-03T23:29:53+00:00'
                    cancelSeconds: 119
                    isLiked: false
                    canPurchase: false
                    canPurchaseReason: free
                    canReport: false
                    canBePinned: true
                    isPinned: false
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats/XXXXXXXXX/messages?limit=10&id=XXXXXXXXX'
                  _meta:
                    _credits:
                      used: 1
                      balance: 1
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      responseType:
                        type: string
                        example: message
                      text:
                        type: string
                        example: '<p>Message text</p>'
                      giphyId:
                        type: string
                        example: null
                      lockedText:
                        type: boolean
                        example: true
                      isFree:
                        type: boolean
                        example: true
                      price:
                        type: integer
                        example: 0
                      isMediaReady:
                        type: boolean
                        example: true
                      mediaCount:
                        type: integer
                        example: 0
                      media:
                        type: array
                        example: []
                      previews:
                        type: array
                        example: []
                      isTip:
                        type: boolean
                        example: false
                      isReportedByMe:
                        type: boolean
                        example: false
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                      queueId:
                        type: integer
                        example: 123
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      releaseForms:
                        type: array
                        example: []
                      fromUser:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 339543013
                          _view:
                            type: string
                            example: s
                      isFromQueue:
                        type: boolean
                        example: false
                      id:
                        type: integer
                        example: 123
                      isOpened:
                        type: boolean
                        example: false
                      isNew:
                        type: boolean
                        example: true
                      createdAt:
                        type: string
                        example: '2025-02-03T23:29:53+00:00'
                      changedAt:
                        type: string
                        example: '2025-02-03T23:29:53+00:00'
                      cancelSeconds:
                        type: integer
                        example: 119
                      isLiked:
                        type: boolean
                        example: false
                      canPurchase:
                        type: boolean
                        example: false
                      canPurchaseReason:
                        type: string
                        example: free
                      canReport:
                        type: boolean
                        example: false
                      canBePinned:
                        type: boolean
                        example: true
                      isPinned:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats/XXXXXXXXX/messages?limit=10&id=XXXXXXXXX'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
        422:
          description: 'Validation Error'
          content:
            application/json:
              schema:
                type: object
                example:
                  error: VALIDATION_ERROR
                  message: 'The text field is required.'
                  description: 'The request parameters failed validation.'
                  errors:
                    text:
                      - 'The text field is required.'
                  _meta:
                    _credits:
                      used: 0
                      balance: 9554
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  error:
                    type: string
                    example: VALIDATION_ERROR
                  message:
                    type: string
                    example: 'The text field is required.'
                  description:
                    type: string
                    example: 'The request parameters failed validation.'
                  errors:
                    type: object
                    properties:
                      text:
                        type: array
                        example:
                          - 'The text field is required.'
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9554
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - 'Chat Messages'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'The message text content. Required unless a media file is present.'
                  example: Hello!
                replyToMessageId:
                  type: integer
                  description: "Mark this message as a reply to another (can be either your own, or the recipient's)"
                  example: 123456789
                lockedText:
                  type: boolean
                  description: 'Whether the text should be shown or hidden'
                  example: true
                price:
                  type: integer
                  description: 'Price for paid content (0 or between 3-200). In case this is not zero, **mediaFiles** is required'
                  example: 10
                mediaFiles:
                  type: array
                  description: 'Direct file uploads, OFAPI `ofapi_media_` IDs, or OF vault IDs. Will be hidden if `price` is provided.'
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: 'file[]|string'
                previews:
                  type: array
                  description: 'Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or integer indices referencing uploaded files in `mediaFiles`. Will be shown if `price` is provided.'
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: 'file[]|string[]|int'
                rfTag:
                  type: string
                  description: 'Array of OnlyFans Creator User IDs to tag in your message'
                  example: null
                rfPartner:
                  type: string
                  description: 'Array of OnlyFans Release Form Partners IDs to tag in your message'
                  example: null
                rfGuest:
                  type: string
                  description: 'Array of OnlyFans Release Form Guest IDs to tag in your message'
                  example: null
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat (usually a fan's OnlyFans User ID)"
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/messages/{message_id}':
    delete:
      summary: 'Delete Message'
      operationId: deleteMessage
      description: 'Delete a message from a chat. Please note that ONLY messages sent less than 24 hours ago can be deleted.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 9976
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9976
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - 'Chat Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
      -
        in: path
        name: message_id
        description: 'The ID of the message to delete'
        example: '123456789'
        required: true
        schema:
          type: string
  '/api/{account}/chats':
    get:
      summary: 'List Chats'
      operationId: listChats
      description: 'Get the list of chats for an Account.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of chats to return (1 - 100). Default = 10'
          example: 10
          required: false
          schema:
            type: string
            description: 'Number of chats to return (1 - 100). Default = 10'
            example: 10
        -
          in: query
          name: offset
          description: 'Number of chats to skip for pagination'
          example: 0
          required: false
          schema:
            type: string
            description: 'Number of chats to skip for pagination'
            example: 0
        -
          in: query
          name: skip_users
          description: 'Whether to skip user details in response (all or none). Default = all'
          example: all
          required: false
          schema:
            type: string
            description: 'Whether to skip user details in response (all or none). Default = all'
            example: all
            enum:
              - all
              - none
        -
          in: query
          name: order
          description: 'Sort order for chats (recent or old). Default = recent'
          example: recent
          required: false
          schema:
            type: string
            description: 'Sort order for chats (recent or old). Default = recent'
            example: recent
            enum:
              - recent
              - old
        -
          in: query
          name: filter
          description: 'Optionally, filter the chats by type.'
          example: with_tips
          required: false
          schema:
            type: string
            description: 'Optionally, filter the chats by type.'
            example: with_tips
            enum:
              - pinned
              - priority
              - unread
              - with_tips
              - unread_with_tips
        -
          in: query
          name: query
          description: 'Search query to filter chats'
          example: John
          required: false
          schema:
            type: string
            description: 'Search query to filter chats'
            example: John
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      canNotSendReason: false
                      canSendMessage: true
                      canGoToProfile: true
                      unreadMessagesCount: 1
                      hasUnreadTips: false
                      isMutedNotifications: false
                      lastMessage:
                        responseType: message
                        text: '<p>Message text</p>'
                        giphyId: null
                        lockedText: false
                        isFree: true
                        price: 0
                        isMediaReady: true
                        mediaCount: 0
                        media: []
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        isCouplePeopleMedia: false
                        queueId: 123
                        isMarkdownDisabled: true
                        fromUser:
                          id: 123
                          _view: i
                        isFromQueue: true
                        canUnsendQueue: true
                        unsendSecondsQueue: 1000000
                        id: 123
                        isOpened: false
                        isNew: true
                        createdAt: '2025-01-01T01:01:01+00:00'
                        changedAt: '2025-01-01T01:01:01+00:00'
                        cancelSeconds: 86268
                        isLiked: false
                        canPurchase: false
                        canPurchaseReason: free
                        canReport: true
                        canBePinned: true
                        isPinned: false
                      lastReadMessageId: 0
                      hasPurchasedFeed: false
                      countPinnedMessages: 0
                      fan:
                        id: 123
                        name: Name
                        view: f
                        about: '<p>About</p>'
                        avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                        header: 'https://public.onlyfans.com/files/.../header.jpg'
                        notice: ''
                        canChat: true
                        canEarn: true
                        tipsMax: 200
                        tipsMin: 5
                        website: null
                        hasLinks: false
                        isFriend: false
                        joinDate: '2025-01-01T01:01:01+00:00'
                        lastSeen: '2025-01-01T01:01:01+00:00'
                        location: Location
                        username: username
                        wishlist: null
                        canReport: true
                        hasLabels: true
                        hasStream: false
                        isBlocked: false
                        hasFriends: false
                        hasStories: false
                        headerSize:
                          width: 767
                          height: 1152
                        isVerified: true
                        postsCount: 123
                        audiosCount: 0
                        canRestrict: true
                        displayName: ''
                        isPerformer: true
                        listsStates:
                          -
                            id: following
                            name: Following
                            type: following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            name: Fans
                            type: fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: rebill_off
                            name: 'Renew Off'
                            type: rebill_off
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: rebill_on
                            name: 'Renew On'
                            type: rebill_on
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: recent
                            name: 'Recent (last 24 hours)'
                            type: recent
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: friends
                            name: Friends
                            type: friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            name: Muted
                            type: muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: tagged
                            name: Tagged
                            type: tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        mediasCount: 123
                        photosCount: 123
                        tipsEnabled: true
                        videosCount: 123
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/.../avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/.../avatar.jpg'
                        canLookStory: true
                        canTrialSend: false
                        headerThumbs:
                          w480: 'https://thumbs.onlyfans.com/.../header.jpg'
                          w760: 'https://thumbs.onlyfans.com/.../header.jpg'
                        isRestricted: false
                        subscribedBy: true
                        subscribedOn: true
                        canCreateTrial: false
                        canPayInternal: true
                        canUnsubscribe: true
                        favoritedCount: 123
                        favoritesCount: 123
                        hasPinnedPosts: false
                        isAdultContent: false
                        showMediaCount: true
                        subscribePrice: 0
                        canCommentStory: true
                        hasSavedStreams: false
                        isRealPerformer: true
                        showPostsInFeed: true
                        tipsMinInternal: 1
                        tipsTextEnabled: true
                        canAddSubscriber: false
                        subscribedByData:
                          price: 0
                          status: null
                          isMuted: false
                          duration: '22 days'
                          newPrice: 0
                          expiredAt: '2025-01-01T01:01:01+00:00'
                          renewedAt: '2025-01-01T01:01:01+00:00'
                          subscribes:
                            -
                              id: 123
                              date: '2025-01-01T01:01:01+00:00'
                              type: regular
                              price: 0
                              action: subscribe
                              userId: 123
                              discount: 0
                              duration: 123
                              offerEnd: null
                              earningId: 0
                              isCurrent: true
                              startDate: '2025-01-01T01:01:01+00:00'
                              cancelDate: null
                              expireDate: '2025-01-01T01:01:01+00:00'
                              offerStart: null
                              regularPrice: 0
                              subscriberId: 123
                          subscribeAt: '2025-01-01T01:01:01+00:00'
                          regularPrice: 0
                          discountPeriod: 1
                          subscribePrice: 0
                          discountPercent: 0
                          showPostsInFeed: true
                          discountStartedAt: null
                          unsubscribeReason: 'No reason given'
                          discountFinishedAt: null
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 0
                          status: null
                          isMuted: false
                          duration: '22 days'
                          newPrice: 0
                          tipsSumm: 0
                          expiredAt: '2025-01-01T01:01:01+00:00'
                          postsSumm: 0
                          renewedAt: '2025-01-01T01:01:01+00:00'
                          totalSumm: 0
                          subscribes:
                            -
                              id: 123
                              date: '2025-01-01T01:01:01+00:00'
                              type: auto
                              price: 0
                              action: subscribe
                              userId: 123
                              discount: 0
                              duration: 123
                              offerEnd: null
                              earningId: 0
                              isCurrent: true
                              startDate: '2025-01-01T01:01:01+00:00'
                              cancelDate: null
                              expireDate: '2025-01-01T01:01:01+00:00'
                              offerStart: null
                              regularPrice: 0
                              subscriberId: 123
                          streamsSumm: 0
                          subscribeAt: '2025-01-01T01:01:01+00:00'
                          messagesSumm: 0
                          regularPrice: 4.99
                          discountPeriod: 1
                          subscribePrice: 4.99
                          subscribesSumm: 0
                          discountPercent: 0
                          discountStartedAt: null
                          unsubscribeReason: 'No reason given'
                          discountFinishedAt: null
                          hasActivePaidSubscriptions: false
                        subscribersCount: null
                        hasNotViewedStory: false
                        isPaywallRequired: true
                        isReferrerAllowed: true
                        isSpringConnected: false
                        archivedPostsCount: 0
                        canCreatePromotion: false
                        hasScheduledStream: false
                        isSpotifyConnected: false
                        subscribedByExpire: false
                        finishedStreamsCount: 0
                        isPendingAutoprolong: false
                        isPrivateRestriction: false
                        showSubscribersCount: false
                        subscribedOnDuration: '22 days'
                        canReceiveChatMessage: true
                        currentSubscribePrice: 0
                        firstPublishedPostDate: '2025-01-01T01:01:01+00:00'
                        subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                        subscribedIsExpiredNow: false
                        subscribedOnExpiredNow: false
                        subscribedByAutoprolong: true
                        privateArchivedPostsCount: 0
                        shouldShowFinishedStreams: false
                        isMarkdownDisabledForAbout: true
                        avatarHeaderConverterUpload: true
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats?offset=10&limit=10'
                  _meta:
                    _credits:
                      used: 1
                      balance: 1
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: array
                    example:
                      -
                        canNotSendReason: false
                        canSendMessage: true
                        canGoToProfile: true
                        unreadMessagesCount: 1
                        hasUnreadTips: false
                        isMutedNotifications: false
                        lastMessage:
                          responseType: message
                          text: '<p>Message text</p>'
                          giphyId: null
                          lockedText: false
                          isFree: true
                          price: 0
                          isMediaReady: true
                          mediaCount: 0
                          media: []
                          previews: []
                          isTip: false
                          isReportedByMe: false
                          isCouplePeopleMedia: false
                          queueId: 123
                          isMarkdownDisabled: true
                          fromUser:
                            id: 123
                            _view: i
                          isFromQueue: true
                          canUnsendQueue: true
                          unsendSecondsQueue: 1000000
                          id: 123
                          isOpened: false
                          isNew: true
                          createdAt: '2025-01-01T01:01:01+00:00'
                          changedAt: '2025-01-01T01:01:01+00:00'
                          cancelSeconds: 86268
                          isLiked: false
                          canPurchase: false
                          canPurchaseReason: free
                          canReport: true
                          canBePinned: true
                          isPinned: false
                        lastReadMessageId: 0
                        hasPurchasedFeed: false
                        countPinnedMessages: 0
                        fan:
                          id: 123
                          name: Name
                          view: f
                          about: '<p>About</p>'
                          avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                          header: 'https://public.onlyfans.com/files/.../header.jpg'
                          notice: ''
                          canChat: true
                          canEarn: true
                          tipsMax: 200
                          tipsMin: 5
                          website: null
                          hasLinks: false
                          isFriend: false
                          joinDate: '2025-01-01T01:01:01+00:00'
                          lastSeen: '2025-01-01T01:01:01+00:00'
                          location: Location
                          username: username
                          wishlist: null
                          canReport: true
                          hasLabels: true
                          hasStream: false
                          isBlocked: false
                          hasFriends: false
                          hasStories: false
                          headerSize:
                            width: 767
                            height: 1152
                          isVerified: true
                          postsCount: 123
                          audiosCount: 0
                          canRestrict: true
                          displayName: ''
                          isPerformer: true
                          listsStates:
                            -
                              id: following
                              name: Following
                              type: following
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            -
                              id: fans
                              name: Fans
                              type: fans
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            -
                              id: rebill_off
                              name: 'Renew Off'
                              type: rebill_off
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: null
                            -
                              id: rebill_on
                              name: 'Renew On'
                              type: rebill_on
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            -
                              id: recent
                              name: 'Recent (last 24 hours)'
                              type: recent
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: SYSTEM_LIST
                            -
                              id: friends
                              name: Friends
                              type: friends
                              hasUser: false
                              canAddUser: true
                              cannotAddUserReason: null
                            -
                              id: muted
                              name: Muted
                              type: muted
                              hasUser: false
                              canAddUser: true
                              cannotAddUserReason: null
                            -
                              id: tagged
                              name: Tagged
                              type: tagged
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: SYSTEM_LIST
                          mediasCount: 123
                          photosCount: 123
                          tipsEnabled: true
                          videosCount: 123
                          avatarThumbs:
                            c50: 'https://thumbs.onlyfans.com/.../avatar.jpg'
                            c144: 'https://thumbs.onlyfans.com/.../avatar.jpg'
                          canLookStory: true
                          canTrialSend: false
                          headerThumbs:
                            w480: 'https://thumbs.onlyfans.com/.../header.jpg'
                            w760: 'https://thumbs.onlyfans.com/.../header.jpg'
                          isRestricted: false
                          subscribedBy: true
                          subscribedOn: true
                          canCreateTrial: false
                          canPayInternal: true
                          canUnsubscribe: true
                          favoritedCount: 123
                          favoritesCount: 123
                          hasPinnedPosts: false
                          isAdultContent: false
                          showMediaCount: true
                          subscribePrice: 0
                          canCommentStory: true
                          hasSavedStreams: false
                          isRealPerformer: true
                          showPostsInFeed: true
                          tipsMinInternal: 1
                          tipsTextEnabled: true
                          canAddSubscriber: false
                          subscribedByData:
                            price: 0
                            status: null
                            isMuted: false
                            duration: '22 days'
                            newPrice: 0
                            expiredAt: '2025-01-01T01:01:01+00:00'
                            renewedAt: '2025-01-01T01:01:01+00:00'
                            subscribes:
                              -
                                id: 123
                                date: '2025-01-01T01:01:01+00:00'
                                type: regular
                                price: 0
                                action: subscribe
                                userId: 123
                                discount: 0
                                duration: 123
                                offerEnd: null
                                earningId: 0
                                isCurrent: true
                                startDate: '2025-01-01T01:01:01+00:00'
                                cancelDate: null
                                expireDate: '2025-01-01T01:01:01+00:00'
                                offerStart: null
                                regularPrice: 0
                                subscriberId: 123
                            subscribeAt: '2025-01-01T01:01:01+00:00'
                            regularPrice: 0
                            discountPeriod: 1
                            subscribePrice: 0
                            discountPercent: 0
                            showPostsInFeed: true
                            discountStartedAt: null
                            unsubscribeReason: 'No reason given'
                            discountFinishedAt: null
                            hasActivePaidSubscriptions: false
                          subscribedOnData:
                            price: 0
                            status: null
                            isMuted: false
                            duration: '22 days'
                            newPrice: 0
                            tipsSumm: 0
                            expiredAt: '2025-01-01T01:01:01+00:00'
                            postsSumm: 0
                            renewedAt: '2025-01-01T01:01:01+00:00'
                            totalSumm: 0
                            subscribes:
                              -
                                id: 123
                                date: '2025-01-01T01:01:01+00:00'
                                type: auto
                                price: 0
                                action: subscribe
                                userId: 123
                                discount: 0
                                duration: 123
                                offerEnd: null
                                earningId: 0
                                isCurrent: true
                                startDate: '2025-01-01T01:01:01+00:00'
                                cancelDate: null
                                expireDate: '2025-01-01T01:01:01+00:00'
                                offerStart: null
                                regularPrice: 0
                                subscriberId: 123
                            streamsSumm: 0
                            subscribeAt: '2025-01-01T01:01:01+00:00'
                            messagesSumm: 0
                            regularPrice: 4.99
                            discountPeriod: 1
                            subscribePrice: 4.99
                            subscribesSumm: 0
                            discountPercent: 0
                            discountStartedAt: null
                            unsubscribeReason: 'No reason given'
                            discountFinishedAt: null
                            hasActivePaidSubscriptions: false
                          subscribersCount: null
                          hasNotViewedStory: false
                          isPaywallRequired: true
                          isReferrerAllowed: true
                          isSpringConnected: false
                          archivedPostsCount: 0
                          canCreatePromotion: false
                          hasScheduledStream: false
                          isSpotifyConnected: false
                          subscribedByExpire: false
                          finishedStreamsCount: 0
                          isPendingAutoprolong: false
                          isPrivateRestriction: false
                          showSubscribersCount: false
                          subscribedOnDuration: '22 days'
                          canReceiveChatMessage: true
                          currentSubscribePrice: 0
                          firstPublishedPostDate: '2025-01-01T01:01:01+00:00'
                          subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                          subscribedIsExpiredNow: false
                          subscribedOnExpiredNow: false
                          subscribedByAutoprolong: true
                          privateArchivedPostsCount: 0
                          shouldShowFinishedStreams: false
                          isMarkdownDisabledForAbout: true
                          avatarHeaderConverterUpload: true
                    items:
                      type: object
                      properties:
                        canNotSendReason:
                          type: boolean
                          example: false
                        canSendMessage:
                          type: boolean
                          example: true
                        canGoToProfile:
                          type: boolean
                          example: true
                        unreadMessagesCount:
                          type: integer
                          example: 1
                        hasUnreadTips:
                          type: boolean
                          example: false
                        isMutedNotifications:
                          type: boolean
                          example: false
                        lastMessage:
                          type: object
                          properties:
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: '<p>Message text</p>'
                            giphyId:
                              type: string
                              example: null
                            lockedText:
                              type: boolean
                              example: false
                            isFree:
                              type: boolean
                              example: true
                            price:
                              type: integer
                              example: 0
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 0
                            media:
                              type: array
                              example: []
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            isCouplePeopleMedia:
                              type: boolean
                              example: false
                            queueId:
                              type: integer
                              example: 123
                            isMarkdownDisabled:
                              type: boolean
                              example: true
                            fromUser:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: i
                            isFromQueue:
                              type: boolean
                              example: true
                            canUnsendQueue:
                              type: boolean
                              example: true
                            unsendSecondsQueue:
                              type: integer
                              example: 1000000
                            id:
                              type: integer
                              example: 123
                            isOpened:
                              type: boolean
                              example: false
                            isNew:
                              type: boolean
                              example: true
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            changedAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            cancelSeconds:
                              type: integer
                              example: 86268
                            isLiked:
                              type: boolean
                              example: false
                            canPurchase:
                              type: boolean
                              example: false
                            canPurchaseReason:
                              type: string
                              example: free
                            canReport:
                              type: boolean
                              example: true
                            canBePinned:
                              type: boolean
                              example: true
                            isPinned:
                              type: boolean
                              example: false
                        lastReadMessageId:
                          type: integer
                          example: 0
                        hasPurchasedFeed:
                          type: boolean
                          example: false
                        countPinnedMessages:
                          type: integer
                          example: 0
                        fan:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: Name
                            view:
                              type: string
                              example: f
                            about:
                              type: string
                              example: '<p>About</p>'
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/.../avatar.jpg'
                            header:
                              type: string
                              example: 'https://public.onlyfans.com/files/.../header.jpg'
                            notice:
                              type: string
                              example: ''
                            canChat:
                              type: boolean
                              example: true
                            canEarn:
                              type: boolean
                              example: true
                            tipsMax:
                              type: integer
                              example: 200
                            tipsMin:
                              type: integer
                              example: 5
                            website:
                              type: string
                              example: null
                            hasLinks:
                              type: boolean
                              example: false
                            isFriend:
                              type: boolean
                              example: false
                            joinDate:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            lastSeen:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            location:
                              type: string
                              example: Location
                            username:
                              type: string
                              example: username
                            wishlist:
                              type: string
                              example: null
                            canReport:
                              type: boolean
                              example: true
                            hasLabels:
                              type: boolean
                              example: true
                            hasStream:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            hasFriends:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 767
                                height:
                                  type: integer
                                  example: 1152
                            isVerified:
                              type: boolean
                              example: true
                            postsCount:
                              type: integer
                              example: 123
                            audiosCount:
                              type: integer
                              example: 0
                            canRestrict:
                              type: boolean
                              example: true
                            displayName:
                              type: string
                              example: ''
                            isPerformer:
                              type: boolean
                              example: true
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  name: Following
                                  type: following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: fans
                                  name: Fans
                                  type: fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: rebill_off
                                  name: 'Renew Off'
                                  type: rebill_off
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                -
                                  id: rebill_on
                                  name: 'Renew On'
                                  type: rebill_on
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: recent
                                  name: 'Recent (last 24 hours)'
                                  type: recent
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: friends
                                  name: Friends
                                  type: friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: muted
                                  name: Muted
                                  type: muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: tagged
                                  name: Tagged
                                  type: tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  type:
                                    type: string
                                    example: following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            mediasCount:
                              type: integer
                              example: 123
                            photosCount:
                              type: integer
                              example: 123
                            tipsEnabled:
                              type: boolean
                              example: true
                            videosCount:
                              type: integer
                              example: 123
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/.../avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/.../avatar.jpg'
                            canLookStory:
                              type: boolean
                              example: true
                            canTrialSend:
                              type: boolean
                              example: false
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/.../header.jpg'
                                w760:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/.../header.jpg'
                            isRestricted:
                              type: boolean
                              example: false
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedOn:
                              type: boolean
                              example: true
                            canCreateTrial:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: true
                            canUnsubscribe:
                              type: boolean
                              example: true
                            favoritedCount:
                              type: integer
                              example: 123
                            favoritesCount:
                              type: integer
                              example: 123
                            hasPinnedPosts:
                              type: boolean
                              example: false
                            isAdultContent:
                              type: boolean
                              example: false
                            showMediaCount:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: integer
                              example: 0
                            canCommentStory:
                              type: boolean
                              example: true
                            hasSavedStreams:
                              type: boolean
                              example: false
                            isRealPerformer:
                              type: boolean
                              example: true
                            showPostsInFeed:
                              type: boolean
                              example: true
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                duration:
                                  type: string
                                  example: '22 days'
                                newPrice:
                                  type: integer
                                  example: 0
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                renewedAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      date: '2025-01-01T01:01:01+00:00'
                                      type: regular
                                      price: 0
                                      action: subscribe
                                      userId: 123
                                      discount: 0
                                      duration: 123
                                      offerEnd: null
                                      earningId: 0
                                      isCurrent: true
                                      startDate: '2025-01-01T01:01:01+00:00'
                                      cancelDate: null
                                      expireDate: '2025-01-01T01:01:01+00:00'
                                      offerStart: null
                                      regularPrice: 0
                                      subscriberId: 123
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T01:01:01+00:00' }
                                      type: { type: string, example: regular }
                                      price: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      userId: { type: integer, example: 123 }
                                      discount: { type: integer, example: 0 }
                                      duration: { type: integer, example: 123 }
                                      offerEnd: { type: string, example: null }
                                      earningId: { type: integer, example: 0 }
                                      isCurrent: { type: boolean, example: true }
                                      startDate: { type: string, example: '2025-01-01T01:01:01+00:00' }
                                      cancelDate: { type: string, example: null }
                                      expireDate: { type: string, example: '2025-01-01T01:01:01+00:00' }
                                      offerStart: { type: string, example: null }
                                      regularPrice: { type: integer, example: 0 }
                                      subscriberId: { type: integer, example: 123 }
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                regularPrice:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                discountStartedAt:
                                  type: string
                                  example: null
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                discountFinishedAt:
                                  type: string
                                  example: null
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                duration:
                                  type: string
                                  example: '22 days'
                                newPrice:
                                  type: integer
                                  example: 0
                                tipsSumm:
                                  type: integer
                                  example: 0
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                postsSumm:
                                  type: integer
                                  example: 0
                                renewedAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                totalSumm:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      date: '2025-01-01T01:01:01+00:00'
                                      type: auto
                                      price: 0
                                      action: subscribe
                                      userId: 123
                                      discount: 0
                                      duration: 123
                                      offerEnd: null
                                      earningId: 0
                                      isCurrent: true
                                      startDate: '2025-01-01T01:01:01+00:00'
                                      cancelDate: null
                                      expireDate: '2025-01-01T01:01:01+00:00'
                                      offerStart: null
                                      regularPrice: 0
                                      subscriberId: 123
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T01:01:01+00:00' }
                                      type: { type: string, example: auto }
                                      price: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      userId: { type: integer, example: 123 }
                                      discount: { type: integer, example: 0 }
                                      duration: { type: integer, example: 123 }
                                      offerEnd: { type: string, example: null }
                                      earningId: { type: integer, example: 0 }
                                      isCurrent: { type: boolean, example: true }
                                      startDate: { type: string, example: '2025-01-01T01:01:01+00:00' }
                                      cancelDate: { type: string, example: null }
                                      expireDate: { type: string, example: '2025-01-01T01:01:01+00:00' }
                                      offerStart: { type: string, example: null }
                                      regularPrice: { type: integer, example: 0 }
                                      subscriberId: { type: integer, example: 123 }
                                streamsSumm:
                                  type: integer
                                  example: 0
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                messagesSumm:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 4.99
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribePrice:
                                  type: number
                                  example: 4.99
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountStartedAt:
                                  type: string
                                  example: null
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                discountFinishedAt:
                                  type: string
                                  example: null
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribersCount:
                              type: string
                              example: null
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isReferrerAllowed:
                              type: boolean
                              example: true
                            isSpringConnected:
                              type: boolean
                              example: false
                            archivedPostsCount:
                              type: integer
                              example: 0
                            canCreatePromotion:
                              type: boolean
                              example: false
                            hasScheduledStream:
                              type: boolean
                              example: false
                            isSpotifyConnected:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: boolean
                              example: false
                            finishedStreamsCount:
                              type: integer
                              example: 0
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                            isPrivateRestriction:
                              type: boolean
                              example: false
                            showSubscribersCount:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: '22 days'
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            firstPublishedPostDate:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            privateArchivedPostsCount:
                              type: integer
                              example: 0
                            shouldShowFinishedStreams:
                              type: boolean
                              example: false
                            isMarkdownDisabledForAbout:
                              type: boolean
                              example: true
                            avatarHeaderConverterUpload:
                              type: boolean
                              example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/chats?offset=10&limit=10'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/chats/mark-as-read':
    post:
      summary: 'Mark All Chats as Read'
      operationId: markAllChatsAsRead
      description: 'Mark all chats as read.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999884
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/media':
    get:
      summary: 'List Chat Media (Gallery)'
      operationId: listChatMediaGallery
      description: 'List media files shared in a specific chat.'
      parameters:
        -
          in: query
          name: type
          description: 'Filter by specific media types. Keep empty to return all.'
          example: claims
          required: false
          schema:
            type: string
            description: 'Filter by specific media types. Keep empty to return all.'
            example: claims
            enum:
              - photos
              - videos
              - audios
            nullable: true
        -
          in: query
          name: limit
          description: 'Number of medias to return. Default = 20'
          example: 20
          required: false
          schema:
            type: string
            description: 'Number of medias to return. Default = 20'
            example: 20
        -
          in: query
          name: offset
          description: 'Number of medias to skip for pagination'
          example: 0
          required: false
          schema:
            type: string
            description: 'Number of medias to skip for pagination'
            example: 0
        -
          in: query
          name: skip_users
          description: 'Whether to skip user details in response (all or none). Default = all'
          example: all
          required: false
          schema:
            type: string
            description: 'Whether to skip user details in response (all or none). Default = all'
            example: all
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        responseType: message
                        text: 'Text message!'
                        giphyId: null
                        lockedText: true
                        isFree: true
                        price: 0
                        isMediaReady: true
                        mediaCount: 1
                        media:
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 2048
                                height: 1360
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 638
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              '240': null
                              '720': null
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        isCouplePeopleMedia: false
                        queueId: 123
                        isMarkdownDisabled: true
                        releaseForms: []
                        fromUser:
                          id: 123
                          _view: t
                        isFromQueue: false
                        id: 123
                        isOpened: false
                        isNew: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        changedAt: '2025-01-01T00:00:00+00:00'
                        cancelSeconds: 0
                        isLiked: false
                        canPurchase: false
                        canPurchaseReason: free
                        canReport: false
                        canBePinned: true
                        isPinned: false
                    hasMore: false
                    nextLastId: '123'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964345
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49985
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            responseType: message
                            text: 'Text message!'
                            giphyId: null
                            lockedText: true
                            isFree: true
                            price: 0
                            isMediaReady: true
                            mediaCount: 1
                            media:
                              -
                                id: 123
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: '2025-01-01T00:00:00+00:00'
                                isReady: true
                                files:
                                  full:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 2048
                                    height: 1360
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 960
                                    height: 638
                                    size: 0
                                  squarePreview:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 960
                                    height: 960
                                    size: 0
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  240: null
                                  720: null
                            previews: []
                            isTip: false
                            isReportedByMe: false
                            isCouplePeopleMedia: false
                            queueId: 123
                            isMarkdownDisabled: true
                            releaseForms: []
                            fromUser:
                              id: 123
                              _view: t
                            isFromQueue: false
                            id: 123
                            isOpened: false
                            isNew: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            changedAt: '2025-01-01T00:00:00+00:00'
                            cancelSeconds: 0
                            isLiked: false
                            canPurchase: false
                            canPurchaseReason: free
                            canReport: false
                            canBePinned: true
                            isPinned: false
                        items:
                          type: object
                          properties:
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: 'Text message!'
                            giphyId:
                              type: string
                              example: null
                            lockedText:
                              type: boolean
                              example: true
                            isFree:
                              type: boolean
                              example: true
                            price:
                              type: integer
                              example: 0
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 1
                            media:
                              type: array
                              example:
                                -
                                  id: 123
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: '2025-01-01T00:00:00+00:00'
                                  isReady: true
                                  files:
                                    full:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 2048
                                      height: 1360
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 960
                                      height: 638
                                      size: 0
                                    squarePreview:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 960
                                      height: 960
                                      size: 0
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    240: null
                                    720: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 2048 }, height: { type: integer, example: 1360 }, size: { type: integer, example: 0 }, sources: { type: array, example: [] } } }
                                      thumb: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 300 }, height: { type: integer, example: 300 }, size: { type: integer, example: 0 } } }
                                      preview: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 960 }, height: { type: integer, example: 638 }, size: { type: integer, example: 0 } } }
                                      squarePreview: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 960 }, height: { type: integer, example: 960 }, size: { type: integer, example: 0 } } }
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      240: { type: string, example: null }
                                      720: { type: string, example: null }
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            isCouplePeopleMedia:
                              type: boolean
                              example: false
                            queueId:
                              type: integer
                              example: 123
                            isMarkdownDisabled:
                              type: boolean
                              example: true
                            releaseForms:
                              type: array
                              example: []
                            fromUser:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: t
                            isFromQueue:
                              type: boolean
                              example: false
                            id:
                              type: integer
                              example: 123
                            isOpened:
                              type: boolean
                              example: false
                            isNew:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            changedAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            cancelSeconds:
                              type: integer
                              example: 0
                            isLiked:
                              type: boolean
                              example: false
                            canPurchase:
                              type: boolean
                              example: false
                            canPurchaseReason:
                              type: string
                              example: free
                            canReport:
                              type: boolean
                              example: false
                            canBePinned:
                              type: boolean
                              example: true
                            isPinned:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: false
                      nextLastId:
                        type: string
                        example: '123'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964345
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49985
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat to get media from, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/typing':
    post:
      summary: 'Start Typing Indicator'
      operationId: startTypingIndicator
      description: 'Calling this endpoint will show the target fan a "Model is typing..." note in the chat for ~4 seconds. If you want to continue showing the indicator call this endpoint multiple times. Free - no credits charged.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 0
                      balance: 224884
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49958
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 224884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49958
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat (usually a fan's OnlyFans User ID)"
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/mute':
    post:
      summary: 'Mute Chat Notifications'
      operationId: muteChatNotifications
      description: 'Mute notifications for a specific chat.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999964347
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999964347
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat to mute, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/unmute':
    delete:
      summary: 'Unmute Chat Notifications'
      operationId: unmuteChatNotifications
      description: 'Unmute notifications for a specific chat.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999957
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4997
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999957
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4997
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat to unmute, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/hide':
    post:
      summary: 'Hide Chat'
      operationId: hideChat
      description: 'Hide a specific chat from the chat list. To unhide this chat, send a new message to the user.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999884
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat to hide, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}':
    delete:
      summary: 'Delete Chat'
      operationId: deleteChat
      description: 'Delete a specific chat.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999884
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat to delete, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/chats/{chat_id}/mark-as-read':
    post:
      summary: 'Mark Chat as Read'
      operationId: markChatAsRead
      description: 'Mark a specific chat as read. Alternative to List Chat Messages endpoint, if you just want to mark the chat as read without fetching messages.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999884
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999884
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Chats
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: chat_id
        description: "The ID of the chat to mark as read, usually a fan's OnlyFans User ID"
        example: '123'
        required: true
        schema:
          type: string
  /api/client-sessions:
    post:
      summary: 'Create Client Session'
      operationId: createClientSession
      description: 'Create Client Session Token for later use in embedded auth components - eg. via @onlyfansapi/auth npm package.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    token: ofapi_cs_OriR8Sdocp0f97eFOdbMMZtiz4Aw5FLX
                    display_name: 'STRLCxGLVC Agency / Model: Stella'
                    client_reference_id: my_crm_model_12345
                  _meta:
                    _credits:
                      used: 0
                      balance: 224907
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      token:
                        type: string
                        example: ofapi_cs_OriR8Sdocp0f97eFOdbMMZtiz4Aw5FLX
                      display_name:
                        type: string
                        example: 'STRLCxGLVC Agency / Model: Stella'
                      client_reference_id:
                        type: string
                        example: my_crm_model_12345
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 224907
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - 'Client Sessions'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                display_name:
                  type: string
                  description: 'Display Name of the account visible in your OnlyFansAPI Console Dashboard.'
                  example: 'STRLCxGLVC Agency / Model: Stella'
                client_reference_id:
                  type: string
                  description: 'Your Internal Reference ID for the connected account.'
                  example: my_crm_model_12345
                proxy_country:
                  type: string
                  description: ''
                  example: it
                  enum:
                    - us
                    - uk
                    - de
                    - fr
                    - it
                  nullable: true
              required:
                - display_name
  /api/authenticate:
    post:
      summary: 'Start Authentication'
      operationId: startAuthentication
      description: 'Start the authentication process for a new account. Our systems will bypass Captcha and also ask you for 2FA code if required. All credentials are stored securely using bcrypt and only used during login.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  attempt_id: auth_XXXXXXXXXXXXXXXXXXXXX
                  message: 'Authentication process started. Query the polling_url to check the progress.'
                  polling_url: 'https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX'
                properties:
                  attempt_id:
                    type: string
                    example: auth_XXXXXXXXXXXXXXXXXXXXX
                  message:
                    type: string
                    example: 'Authentication process started. Query the polling_url to check the progress.'
                  polling_url:
                    type: string
                    example: 'https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXXXXXXXXXXXXXXXX'
      tags:
        - 'Connect OnlyFans Account'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: 'The email address of the OnlyFans account'
                  example: judge.runolfsson@example.com
                password:
                  type: string
                  description: 'The password of the OnlyFans account'
                  example: CIb5mA~O7O
                proxyCountry:
                  type: string
                  description: 'The country of the managed proxy server you want to use. Eg. "us" for United States. Cannot be used together with customProxy.'
                  example: uk
                  enum:
                    - us
                    - uk
                    - de
                    - fr
                    - it
                customProxy:
                  type: object
                  description: 'Custom proxy configuration. Cannot be used together with proxyCountry.'
                  example: []
                  properties:
                    host:
                      type: string
                      description: 'The hostname or IP address of your custom proxy server'
                      example: proxy.example.com
                    port:
                      type: integer
                      description: 'The port number of your custom proxy server (1-65535)'
                      example: 8080
                    username:
                      type: string
                      description: 'The username for proxy authentication (optional)'
                      example: vel
                    password:
                      type: string
                      description: 'The password for proxy authentication (optional)'
                      example: "%#FWPC#hFzg'Sn^Oj"
                force_connect:
                  type: boolean
                  description: 'Set to true to connect the account even if it already exists'
                  example: true
              required:
                - email
                - password
  '/api/authenticate/{attempt_id}':
    get:
      summary: 'Poll Authentication Status'
      operationId: pollAuthenticationStatus
      description: 'Poll the status of the authentication process. Eg. if 2FA is required, we will ask you for the code using the `twoFactorPending = true` in the response body.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  account:
                    id: acct_4d3fa20f055b4cbababab0d7e400550d
                    display_name: ipgod@gmail.com
                    onlyfans_data:
                      id: 123456789
                      ip: 127.0.0.1
                      csrf: abcdef123456789
                      name: 'Demo User'
                      view: f
                      about: null
                      email: demo@example.com
                      wsUrl: 'wss://ws2.onlyfans.com/ws3/00'
                      avatar: null
                      header: null
                      isAuth: true
                      ivFlow: default
                      upload:
                        geoUploadArgs:
                          preset: of_beta
                          isDelay: true
                          additional:
                            user: '123456789'
                          needThumbs: true
                          preset_png: of_png
                          protected_preset: of_drm
                      canChat: true
                      hasTags: true
                      website: null
                      advBlock:
                        - subscribe_offers
                      ivStatus: null
                      joinDate: '2022-01-01T00:00:00+00:00'
                      lastSeen: '2025-01-01T12:00:00+00:00'
                      location: null
                      paidFeed: false
                      username: demouser123
                      wishlist: null
                      hasLabels: false
                      ivCountry: null
                      canAddCard: true
                      canPinPost: true
                      creditsMax: 200
                      creditsMin: 10
                      headerSize: null
                      isVerified: false
                      postsCount: 0
                      audiosCount: 0
                      hasNewHints: true
                      hasScenario: true
                      isPerformer: false
                      mediasCount: 0
                      photosCount: 0
                      videosCount: 0
                      wsAuthToken: dummy.jwt.token
                      avatarThumbs: null
                      canLookStory: true
                      hasNewAlerts: false
                      headerThumbs: null
                      isOtpEnabled: false
                      ivFailReason: 'Verification failed'
                      newTagsCount: 0
                      creditBalance: 0
                      faceIdRegular: []
                      isAgeVerified: true
                      isAllowTweets: false
                      isMakePayment: false
                      needIVApprove: false
                      watermarkText: OnlyFans.com/demouser123
                      canCreateLists: true
                      canPayInternal: true
                      favoritedCount: 0
                      favoritesCount: 0
                      hasPinnedPosts: false
                      isEmailChecked: false
                      isWantComments: true
                      canCommentStory: true
                      countPinnedChat: 0
                      isEmailRequired: false
                      isPaywallPassed: false
                      isRealPerformer: false
                      isVisibleOnline: true
                      showPostsInFeed: true
                      subscribesCount: 0
                      twitterUsername: null
                      canSendChatToAll: false
                      isCreditsEnabled: true
                      pinnedPostsCount: 0
                      subscribersCount: 0
                      chatMessagesCount: 0
                      countPriorityChat: 0
                      hasNotViewedStory: false
                      hasPurchasedPosts: false
                      hasWatermarkPhoto: true
                      hasWatermarkVideo: true
                      isDeleteInitiated: false
                      isReferrerAllowed: false
                      watermarkPosition: bottom_right
                      archivedPostsCount: 0
                      isSpotifyConnected: false
                      isTwitterConnected: false
                      notificationsCount: 0
                      walletFirstRebills: false
                      canConnectOfAccount: false
                      connectedOfAccounts: []
                      hasInternalPayments: false
                      hasNewTicketReplies:
                        open: false
                        closed: false
                        solved: false
                      isRealCardConnected: false
                      maxPinnedPostsCount: 5
                      isWalletAutorecharge: false
                      canReceiveChatMessage: false
                      walletAutorechargeMin: 0
                      ageVerificationSession:
                        url: 'https://age.yoti.com/age-estimation?sessionId=dummy-session-id&sdkId=dummy-sdk-id'
                        status: complete
                        apiFlow: of3
                        expiredAt: '2022-11-15T00:54:42+00:00'
                      hasSystemNotifications: false
                      isLegalApprovedAllowed: false
                      isPaymentCardConnected: false
                      ageVerificationRequired: false
                      payoutLegalApproveState: none
                      walletAutorechargeAmount: 0
                      canAlternativeWalletTopUp: false
                      enabledImageEditorForChat: true
                      privateArchivedPostsCount: 0
                      isMarkdownDisabledForAbout: false
                      avatarHeaderConverterUpload: true
                      hasNewChangedPriceSubscriptions: false
                  state: authenticated
                  progress: signed_in
                  lastAttempt:
                    started_at: '2025-03-30T19:40:09.000000Z'
                    completed_at: '2025-03-30T19:41:44.000000Z'
                    success: true
                    error_message: null
                    error_code: null
                    needs_otp: false
                    otp_phone_ending: null
                properties:
                  account:
                    type: object
                    properties:
                      id:
                        type: string
                        example: acct_4d3fa20f055b4cbababab0d7e400550d
                      display_name:
                        type: string
                        example: ipgod@gmail.com
                      onlyfans_data:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123456789
                          ip:
                            type: string
                            example: 127.0.0.1
                          csrf:
                            type: string
                            example: abcdef123456789
                          name:
                            type: string
                            example: 'Demo User'
                          view:
                            type: string
                            example: f
                          about:
                            type: string
                            example: null
                          email:
                            type: string
                            example: demo@example.com
                          wsUrl:
                            type: string
                            example: 'wss://ws2.onlyfans.com/ws3/00'
                          avatar:
                            type: string
                            example: null
                          header:
                            type: string
                            example: null
                          isAuth:
                            type: boolean
                            example: true
                          ivFlow:
                            type: string
                            example: default
                          upload:
                            type: object
                            properties:
                              geoUploadArgs:
                                type: object
                                properties:
                                  preset:
                                    type: string
                                    example: of_beta
                                  isDelay:
                                    type: boolean
                                    example: true
                                  additional:
                                    type: object
                                    properties:
                                      user: { type: string, example: '123456789' }
                                  needThumbs:
                                    type: boolean
                                    example: true
                                  preset_png:
                                    type: string
                                    example: of_png
                                  protected_preset:
                                    type: string
                                    example: of_drm
                          canChat:
                            type: boolean
                            example: true
                          hasTags:
                            type: boolean
                            example: true
                          website:
                            type: string
                            example: null
                          advBlock:
                            type: array
                            example:
                              - subscribe_offers
                            items:
                              type: string
                          ivStatus:
                            type: string
                            example: null
                          joinDate:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          lastSeen:
                            type: string
                            example: '2025-01-01T12:00:00+00:00'
                          location:
                            type: string
                            example: null
                          paidFeed:
                            type: boolean
                            example: false
                          username:
                            type: string
                            example: demouser123
                          wishlist:
                            type: string
                            example: null
                          hasLabels:
                            type: boolean
                            example: false
                          ivCountry:
                            type: string
                            example: null
                          canAddCard:
                            type: boolean
                            example: true
                          canPinPost:
                            type: boolean
                            example: true
                          creditsMax:
                            type: integer
                            example: 200
                          creditsMin:
                            type: integer
                            example: 10
                          headerSize:
                            type: string
                            example: null
                          isVerified:
                            type: boolean
                            example: false
                          postsCount:
                            type: integer
                            example: 0
                          audiosCount:
                            type: integer
                            example: 0
                          hasNewHints:
                            type: boolean
                            example: true
                          hasScenario:
                            type: boolean
                            example: true
                          isPerformer:
                            type: boolean
                            example: false
                          mediasCount:
                            type: integer
                            example: 0
                          photosCount:
                            type: integer
                            example: 0
                          videosCount:
                            type: integer
                            example: 0
                          wsAuthToken:
                            type: string
                            example: dummy.jwt.token
                          avatarThumbs:
                            type: string
                            example: null
                          canLookStory:
                            type: boolean
                            example: true
                          hasNewAlerts:
                            type: boolean
                            example: false
                          headerThumbs:
                            type: string
                            example: null
                          isOtpEnabled:
                            type: boolean
                            example: false
                          ivFailReason:
                            type: string
                            example: 'Verification failed'
                          newTagsCount:
                            type: integer
                            example: 0
                          creditBalance:
                            type: integer
                            example: 0
                          faceIdRegular:
                            type: array
                            example: []
                          isAgeVerified:
                            type: boolean
                            example: true
                          isAllowTweets:
                            type: boolean
                            example: false
                          isMakePayment:
                            type: boolean
                            example: false
                          needIVApprove:
                            type: boolean
                            example: false
                          watermarkText:
                            type: string
                            example: OnlyFans.com/demouser123
                          canCreateLists:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          favoritedCount:
                            type: integer
                            example: 0
                          favoritesCount:
                            type: integer
                            example: 0
                          hasPinnedPosts:
                            type: boolean
                            example: false
                          isEmailChecked:
                            type: boolean
                            example: false
                          isWantComments:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          countPinnedChat:
                            type: integer
                            example: 0
                          isEmailRequired:
                            type: boolean
                            example: false
                          isPaywallPassed:
                            type: boolean
                            example: false
                          isRealPerformer:
                            type: boolean
                            example: false
                          isVisibleOnline:
                            type: boolean
                            example: true
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribesCount:
                            type: integer
                            example: 0
                          twitterUsername:
                            type: string
                            example: null
                          canSendChatToAll:
                            type: boolean
                            example: false
                          isCreditsEnabled:
                            type: boolean
                            example: true
                          pinnedPostsCount:
                            type: integer
                            example: 0
                          subscribersCount:
                            type: integer
                            example: 0
                          chatMessagesCount:
                            type: integer
                            example: 0
                          countPriorityChat:
                            type: integer
                            example: 0
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          hasPurchasedPosts:
                            type: boolean
                            example: false
                          hasWatermarkPhoto:
                            type: boolean
                            example: true
                          hasWatermarkVideo:
                            type: boolean
                            example: true
                          isDeleteInitiated:
                            type: boolean
                            example: false
                          isReferrerAllowed:
                            type: boolean
                            example: false
                          watermarkPosition:
                            type: string
                            example: bottom_right
                          archivedPostsCount:
                            type: integer
                            example: 0
                          isSpotifyConnected:
                            type: boolean
                            example: false
                          isTwitterConnected:
                            type: boolean
                            example: false
                          notificationsCount:
                            type: integer
                            example: 0
                          walletFirstRebills:
                            type: boolean
                            example: false
                          canConnectOfAccount:
                            type: boolean
                            example: false
                          connectedOfAccounts:
                            type: array
                            example: []
                          hasInternalPayments:
                            type: boolean
                            example: false
                          hasNewTicketReplies:
                            type: object
                            properties:
                              open:
                                type: boolean
                                example: false
                              closed:
                                type: boolean
                                example: false
                              solved:
                                type: boolean
                                example: false
                          isRealCardConnected:
                            type: boolean
                            example: false
                          maxPinnedPostsCount:
                            type: integer
                            example: 5
                          isWalletAutorecharge:
                            type: boolean
                            example: false
                          canReceiveChatMessage:
                            type: boolean
                            example: false
                          walletAutorechargeMin:
                            type: integer
                            example: 0
                          ageVerificationSession:
                            type: object
                            properties:
                              url:
                                type: string
                                example: 'https://age.yoti.com/age-estimation?sessionId=dummy-session-id&sdkId=dummy-sdk-id'
                              status:
                                type: string
                                example: complete
                              apiFlow:
                                type: string
                                example: of3
                              expiredAt:
                                type: string
                                example: '2022-11-15T00:54:42+00:00'
                          hasSystemNotifications:
                            type: boolean
                            example: false
                          isLegalApprovedAllowed:
                            type: boolean
                            example: false
                          isPaymentCardConnected:
                            type: boolean
                            example: false
                          ageVerificationRequired:
                            type: boolean
                            example: false
                          payoutLegalApproveState:
                            type: string
                            example: none
                          walletAutorechargeAmount:
                            type: integer
                            example: 0
                          canAlternativeWalletTopUp:
                            type: boolean
                            example: false
                          enabledImageEditorForChat:
                            type: boolean
                            example: true
                          privateArchivedPostsCount:
                            type: integer
                            example: 0
                          isMarkdownDisabledForAbout:
                            type: boolean
                            example: false
                          avatarHeaderConverterUpload:
                            type: boolean
                            example: true
                          hasNewChangedPriceSubscriptions:
                            type: boolean
                            example: false
                  state:
                    type: string
                    example: authenticated
                  progress:
                    type: string
                    example: signed_in
                  lastAttempt:
                    type: object
                    properties:
                      started_at:
                        type: string
                        example: '2025-03-30T19:40:09.000000Z'
                      completed_at:
                        type: string
                        example: '2025-03-30T19:41:44.000000Z'
                      success:
                        type: boolean
                        example: true
                      error_message:
                        type: string
                        example: null
                      error_code:
                        type: string
                        example: null
                      needs_otp:
                        type: boolean
                        example: false
                      otp_phone_ending:
                        type: string
                        example: null
      tags:
        - 'Connect OnlyFans Account'
    put:
      summary: 'Submit 2FA'
      operationId: submit2FA
      description: 'Submit the 2FA code, or Selfie Verification status, for the authentication process.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'OTP submitted successfully'
                properties:
                  message:
                    type: string
                    example: 'OTP submitted successfully'
      tags:
        - 'Connect OnlyFans Account'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                code:
                  type: string
                  description: 'The 2FA code you received on your phone. Must be empty if `selfie_verification_completed` is `true`.'
                  example: '12345'
                selfie_verification_completed:
                  type: boolean
                  description: 'This field is required when <code>code</code> is not present.'
                  example: 'true'
                  enum:
                    - 'true'
    parameters:
      -
        in: path
        name: attempt_id
        description: 'The attempt ID of the authentication process'
        example: auth_XXXXXXX
        required: true
        schema:
          type: string
  '/api/authenticate/{attempt_id}/send-email-to-creator':
    post:
      summary: 'Send 2FA E-mail to Creator'
      operationId: send2FAEMailToCreator
      description: "Send 2FA verification e-mail to the creator's email so they can verify login on their device without your input. The e-mail will be sent to the e-mail address used for signing into OnlyFans."
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'E-mail sent to creator-123@gmail.com'
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'E-mail sent to creator-123@gmail.com'
      tags:
        - 'Connect OnlyFans Account'
    parameters:
      -
        in: path
        name: attempt_id
        description: 'The attempt ID of the authentication process'
        example: auth_XXXXXXX
        required: true
        schema:
          type: string
  '/api/authenticate/{account_id}/reauthenticate':
    post:
      summary: 'Re-authenticate Account'
      operationId: reAuthenticateAccount
      description: 'Trigger account reauthentication without the need to submit email & password again.'
      parameters: []
      responses:
        200:
          description: 'Re-authentication started'
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  message: 'Re-authentication started.'
                  polling_url: 'https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXX'
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: 'Re-authentication started.'
                  polling_url:
                    type: string
                    example: 'https://app.onlyfansapi.com/api/authenticate/auth_XXXXXXX'
        400:
          description: 'When re-authentication is not possible'
          content:
            application/json:
              schema:
                type: object
                example:
                  message: "Can't re-authenticate account at this time."
                  reason: 'Account is already successfully authenticated'
                properties:
                  message:
                    type: string
                    example: "Can't re-authenticate account at this time."
                  reason:
                    type: string
                    example: 'Account is already successfully authenticated'
      tags:
        - 'Connect OnlyFans Account'
    parameters:
      -
        in: path
        name: account_id
        description: 'The Account ID of the authentication process'
        example: acct_XXXXXXXXXX
        required: true
        schema:
          type: string
  /api/data-exports:
    get:
      summary: 'List Data Exports'
      operationId: listDataExports
      description: 'Get a paginated list of data exports for the team'
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page. Default `15`, max `100`'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of results per page. Default `15`, max `100`'
            example: 15
        -
          in: query
          name: page
          description: 'Page number for pagination. Default `1`'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number for pagination. Default `1`'
            example: 1
        -
          in: query
          name: status
          description: 'Filter by status'
          example: completed
          required: false
          schema:
            type: string
            description: 'Filter by status'
            example: completed
            enum:
              - calculating_credits
              - calculating_credits_failed
              - calculating_credits_completed
              - pending
              - in_progress
              - completed
              - failed
        -
          in: query
          name: type
          description: 'Filter by export type'
          example: transactions
          required: false
          schema:
            type: string
            description: 'Filter by export type'
            example: transactions
            enum:
              - transactions
              - chat_messages
              - media_vault
              - trial_links
              - tracking_links
              - payouts
              - chargebacks
              - public_profiles
        -
          in: query
          name: download_url_expires_in
          description: 'Number of minutes until download URLs expire. Min `1`, max `60`, default `5`.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of minutes until download URLs expire. Min `1`, max `60`, default `5`.'
            example: 15
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    data:
                      -
                        id: data_export_abc123xyz789
                        type: transactions
                        status: completed
                        start_date: '2024-01-01T00:00:00+00:00'
                        end_date: '2024-12-31T23:59:59+00:00'
                        file_type: csv
                        total_rows: 5000
                        rows_processed: 5000
                        progress_percentage: 100
                        credit_cost: 500
                        export_columns:
                          - transaction_id
                          - type
                          - amount
                          - net_amount
                          - currency
                          - created_at
                        accounts:
                          -
                            id: acct_xyz789abc123
                            display_name: 'Main Account'
                        created_at: '2024-12-01T10:00:00+00:00'
                        completed_at: '2024-12-01T10:05:00+00:00'
                        failed_at: null
                        failed_reason: null
                        download_url: 'https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_abc123xyz789.csv?X-Amz-Signature=...'
                        download_url_expires_at: '2024-12-02T12:05:00+00:00'
                      -
                        id: data_export_def456uvw012
                        type: chat_messages
                        status: in_progress
                        start_date: '2024-06-01T00:00:00+00:00'
                        end_date: '2024-12-31T23:59:59+00:00'
                        file_type: xlsx
                        total_rows: 15000
                        rows_processed: 7500
                        progress_percentage: 50
                        credit_cost: 1500
                        export_columns:
                          - chat_id
                          - message_id
                          - message_text
                          - fan_username
                          - onlyfans_created_at
                        accounts:
                          -
                            id: acct_xyz789abc123
                            display_name: 'Main Account'
                          -
                            id: acct_mno345pqr678
                            display_name: 'Secondary Account'
                        created_at: '2024-12-02T11:30:00+00:00'
                        completed_at: null
                        failed_at: null
                        failed_reason: null
                    meta:
                      current_page: 1
                      last_page: 3
                      per_page: 15
                      total: 42
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ''
                properties:
                  data:
                    type: object
                    properties:
                      data:
                        type: array
                        example:
                          -
                            id: data_export_abc123xyz789
                            type: transactions
                            status: completed
                            start_date: '2024-01-01T00:00:00+00:00'
                            end_date: '2024-12-31T23:59:59+00:00'
                            file_type: csv
                            total_rows: 5000
                            rows_processed: 5000
                            progress_percentage: 100
                            credit_cost: 500
                            export_columns:
                              - transaction_id
                              - type
                              - amount
                              - net_amount
                              - currency
                              - created_at
                            accounts:
                              -
                                id: acct_xyz789abc123
                                display_name: 'Main Account'
                            created_at: '2024-12-01T10:00:00+00:00'
                            completed_at: '2024-12-01T10:05:00+00:00'
                            failed_at: null
                            failed_reason: null
                            download_url: 'https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_abc123xyz789.csv?X-Amz-Signature=...'
                            download_url_expires_at: '2024-12-02T12:05:00+00:00'
                          -
                            id: data_export_def456uvw012
                            type: chat_messages
                            status: in_progress
                            start_date: '2024-06-01T00:00:00+00:00'
                            end_date: '2024-12-31T23:59:59+00:00'
                            file_type: xlsx
                            total_rows: 15000
                            rows_processed: 7500
                            progress_percentage: 50
                            credit_cost: 1500
                            export_columns:
                              - chat_id
                              - message_id
                              - message_text
                              - fan_username
                              - onlyfans_created_at
                            accounts:
                              -
                                id: acct_xyz789abc123
                                display_name: 'Main Account'
                              -
                                id: acct_mno345pqr678
                                display_name: 'Secondary Account'
                            created_at: '2024-12-02T11:30:00+00:00'
                            completed_at: null
                            failed_at: null
                            failed_reason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: data_export_abc123xyz789
                            type:
                              type: string
                              example: transactions
                            status:
                              type: string
                              example: completed
                            start_date:
                              type: string
                              example: '2024-01-01T00:00:00+00:00'
                            end_date:
                              type: string
                              example: '2024-12-31T23:59:59+00:00'
                            file_type:
                              type: string
                              example: csv
                            total_rows:
                              type: integer
                              example: 5000
                            rows_processed:
                              type: integer
                              example: 5000
                            progress_percentage:
                              type: integer
                              example: 100
                            credit_cost:
                              type: integer
                              example: 500
                            export_columns:
                              type: array
                              example:
                                - transaction_id
                                - type
                                - amount
                                - net_amount
                                - currency
                                - created_at
                              items:
                                type: string
                            accounts:
                              type: array
                              example:
                                -
                                  id: acct_xyz789abc123
                                  display_name: 'Main Account'
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: acct_xyz789abc123
                                  display_name:
                                    type: string
                                    example: 'Main Account'
                            created_at:
                              type: string
                              example: '2024-12-01T10:00:00+00:00'
                            completed_at:
                              type: string
                              example: '2024-12-01T10:05:00+00:00'
                            failed_at:
                              type: string
                              example: null
                            failed_reason:
                              type: string
                              example: null
                            download_url:
                              type: string
                              example: 'https://example-bucket.s3.amazonaws.com/data-exports/team-slug/data_export_abc123xyz789.csv?X-Amz-Signature=...'
                            download_url_expires_at:
                              type: string
                              example: '2024-12-02T12:05:00+00:00'
                      meta:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          last_page:
                            type: integer
                            example: 3
                          per_page:
                            type: integer
                            example: 15
                          total:
                            type: integer
                            example: 42
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: ''
      tags:
        - 'Data Exports'
    post:
      summary: 'Create Data Export'
      operationId: createDataExport
      description: 'Create a new data export request. This will calculate the required credits and prepare the export for starting.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: data_export_abc123xyz789
                    type: chat_messages
                    status: calculating_credits
                    start_date: '2024-01-01T00:00:00+00:00'
                    end_date: '2024-12-31T23:59:59+00:00'
                    file_type: csv
                    created_at: '2024-12-02T12:00:00+00:00'
                    requires_scraping: true
                    credit_calculation_note: 'This export type requires data scraping. Credits will be calculated and charged after scraping completes.'
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ''
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: data_export_abc123xyz789
                      type:
                        type: string
                        example: chat_messages
                      status:
                        type: string
                        example: calculating_credits
                      start_date:
                        type: string
                        example: '2024-01-01T00:00:00+00:00'
                      end_date:
                        type: string
                        example: '2024-12-31T23:59:59+00:00'
                      file_type:
                        type: string
                        example: csv
                      created_at:
                        type: string
                        example: '2024-12-02T12:00:00+00:00'
                      requires_scraping:
                        type: boolean
                        example: true
                      credit_calculation_note:
                        type: string
                        example: 'This export type requires data scraping. Credits will be calculated and charged after scraping completes.'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: ''
      tags:
        - 'Data Exports'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: 'The type of data to export'
                  example: transactions
                  enum:
                    - transactions
                    - chat_messages
                    - media_vault
                    - trial_links
                    - tracking_links
                    - payouts
                    - chargebacks
                    - public_profiles
                account_ids:
                  type: array
                  description: 'Array of account prefixed IDs to export data from. Not required for `public_profiles` type.'
                  example:
                    - acc_abc123
                    - acc_def456
                  items:
                    type: string
                start_date:
                  type: string
                  description: 'The start date for the export (ISO 8601 format). Not required for `public_profiles` type.'
                  example: '2024-01-01T00:00:00Z'
                end_date:
                  type: string
                  description: 'The end date for the export (ISO 8601 format). Not required for `public_profiles` type.'
                  example: '2024-12-31T23:59:59Z'
                export_columns:
                  type: array
                  description: 'Array of column names to include in the export (optional, defaults to all columns for the export type)'
                  example:
                    - transaction_id
                    - amount
                    - created_at
                  items:
                    type: string
                file_type:
                  type: string
                  description: 'The output file format. Supported formats vary by export type: `csv` or `xlsx` for transactions, chat_messages, trial_links, tracking_links, payouts, chargebacks, public_profiles; `zip` for media_vault.'
                  example: csv
                  enum:
                    - csv
                    - xlsx
                    - zip
                options:
                  type: object
                  description: 'Type-specific export options. For `chat_messages`: `maxChats` (optional), `maxMessages` (required, max 100,000), `skipMassMessages` (optional, bool). For `public_profiles`: `query` (optional, full-text search), `gender` (optional, filter: male, female, trans, couple), `minSubscribePrice` (optional, USD), `maxSubscribePrice` (optional, USD), `location` (optional), `minPostsCount` (optional, minimum posts), `minPhotosCount` (optional, minimum photos), `minVideosCount` (optional, minimum videos), `minSubscribersCount` (optional, minimum subscribers), `minJoinDate` (optional, ISO 8601 date), `minLastSeenAt` (optional, ISO 8601 date), `createdAtFrom` (optional, ISO 8601 date, profile added to DB after), `createdAtTo` (optional, ISO 8601 date, profile added to DB before), `instagram` (optional), `twitter` (optional), `tiktok` (optional), `maxResults` (optional, limit results).'
                  example:
                    maxChats: 100
                    maxMessages: 50000
                    skipMassMessages: false
                  properties: {  }
                auto_start:
                  type: boolean
                  description: 'When true, automatically starts the export after creation.'
                  example: true
              required:
                - type
                - file_type
  '/api/data-exports/{data_export_id}':
    get:
      summary: 'Get Data Export Status'
      operationId: getDataExportStatus
      description: 'Get the current status and progress of a data export'
      parameters:
        -
          in: query
          name: download_url_expires_in
          description: 'Number of minutes until the download URL expires. Min `1`, max `60`, default `5`.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of minutes until the download URL expires. Min `1`, max `60`, default `5`.'
            example: 15
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: data_export_abc123xyz789
                    type: transactions
                    status: in_progress
                    start_date: '2024-01-01T00:00:00+00:00'
                    end_date: '2024-12-31T23:59:59+00:00'
                    file_type: csv
                    total_rows: 5000
                    rows_processed: 2500
                    progress_percentage: 50
                    credit_cost: 500
                    export_columns:
                      - transaction_id
                      - type
                      - amount
                      - net_amount
                      - currency
                      - created_at
                    accounts:
                      -
                        id: acct_xyz789abc123
                        display_name: 'Main Account'
                    created_at: '2024-12-02T12:00:00+00:00'
                    completed_at: null
                    failed_at: null
                    failed_reason: null
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ''
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: data_export_abc123xyz789
                      type:
                        type: string
                        example: transactions
                      status:
                        type: string
                        example: in_progress
                      start_date:
                        type: string
                        example: '2024-01-01T00:00:00+00:00'
                      end_date:
                        type: string
                        example: '2024-12-31T23:59:59+00:00'
                      file_type:
                        type: string
                        example: csv
                      total_rows:
                        type: integer
                        example: 5000
                      rows_processed:
                        type: integer
                        example: 2500
                      progress_percentage:
                        type: integer
                        example: 50
                      credit_cost:
                        type: integer
                        example: 500
                      export_columns:
                        type: array
                        example:
                          - transaction_id
                          - type
                          - amount
                          - net_amount
                          - currency
                          - created_at
                        items:
                          type: string
                      accounts:
                        type: array
                        example:
                          -
                            id: acct_xyz789abc123
                            display_name: 'Main Account'
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: acct_xyz789abc123
                            display_name:
                              type: string
                              example: 'Main Account'
                      created_at:
                        type: string
                        example: '2024-12-02T12:00:00+00:00'
                      completed_at:
                        type: string
                        example: null
                      failed_at:
                        type: string
                        example: null
                      failed_reason:
                        type: string
                        example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: ''
      tags:
        - 'Data Exports'
    parameters:
      -
        in: path
        name: data_export_id
        description: 'The prefixed ID of the data export'
        example: data_export_abc123
        required: true
        schema:
          type: string
  '/api/data-exports/{data_export_id}/start':
    post:
      summary: 'Start Data Export'
      operationId: startDataExport
      description: 'Start processing a data export that has completed credit calculation. This will begin the actual export process and charge credits.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: data_export_abc123xyz789
                    status: pending
                    message: 'Data export has been started.'
                  _meta:
                    _credits:
                      used: 0
                      balance: 9500
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 60
                      limit_day: null
                      remaining_minute: 56
                      remaining_day: null
                      notice: ''
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: data_export_abc123xyz789
                      status:
                        type: string
                        example: pending
                      message:
                        type: string
                        example: 'Data export has been started.'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9500
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 60
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 56
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: ''
      tags:
        - 'Data Exports'
    parameters:
      -
        in: path
        name: data_export_id
        description: 'The prefixed ID of the data export'
        example: data_export_abc123
        required: true
        schema:
          type: string
  '/api/{account}/engagement/messages/mass-messages':
    get:
      summary: 'Mass Messages'
      operationId: massMessages
      description: 'List sent mass messages with engagement stats (sent, viewed, purchased, etc.).'
      parameters:
        -
          in: query
          name: startDate
          description: 'The earliest message to retrieve. Keep empty to get all.'
          example: '2026-01-07 00:00:00'
          required: false
          schema:
            type: string
            description: 'The earliest message to retrieve. Keep empty to get all.'
            example: '2026-01-07 00:00:00'
        -
          in: query
          name: endDate
          description: 'The latest message to retrieve. Keep empty to get all. MUST BE DATE AFTER `startDate`. This is also used for pagination.'
          example: '2026-02-06 01:26:15'
          required: false
          schema:
            type: string
            description: 'The latest message to retrieve. Keep empty to get all. MUST BE DATE AFTER `startDate`. This is also used for pagination.'
            example: '2026-02-06 01:26:15'
        -
          in: query
          name: limit
          description: 'Number of messages to return (default = 10)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of messages to return (default = 10)'
            example: 10
        -
          in: query
          name: query
          description: 'Optionally, filter by message text.'
          example: sciss
          required: false
          schema:
            type: string
            description: 'Optionally, filter by message text.'
            example: sciss
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: true
                    items:
                      -
                        id: 1234567890
                        date: '2026-02-06T00:51:23+00:00'
                        responseType: message
                        text: '<p>Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?</p>'
                        rawText: 'Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?'
                        giphyId: null
                        isFree: true
                        isMediaReady: true
                        mediaCount: 0
                        media: []
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        viewedCount: 203
                        sentCount: 68400
                        isCanceled: false
                        template: group
                        canUnsend: true
                        unsendSeconds: 1000000
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/mass-messages?endDate=2026-02-05%2011%3A06%3A57&limit=10'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: true
                      items:
                        type: array
                        example:
                          -
                            id: 1234567890
                            date: '2026-02-06T00:51:23+00:00'
                            responseType: message
                            text: '<p>Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?</p>'
                            rawText: 'Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?'
                            giphyId: null
                            isFree: true
                            isMediaReady: true
                            mediaCount: 0
                            media: []
                            previews: []
                            isTip: false
                            isReportedByMe: false
                            viewedCount: 203
                            sentCount: 68400
                            isCanceled: false
                            template: group
                            canUnsend: true
                            unsendSeconds: 1000000
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1234567890
                            date:
                              type: string
                              example: '2026-02-06T00:51:23+00:00'
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: '<p>Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?</p>'
                            rawText:
                              type: string
                              example: 'Lets play ADULT ROCK-PAPER-SCISSORS babe, shall we?'
                            giphyId:
                              type: string
                              example: null
                            isFree:
                              type: boolean
                              example: true
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 0
                            media:
                              type: array
                              example: []
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            viewedCount:
                              type: integer
                              example: 203
                            sentCount:
                              type: integer
                              example: 68400
                            isCanceled:
                              type: boolean
                              example: false
                            template:
                              type: string
                              example: group
                            canUnsend:
                              type: boolean
                              example: true
                            unsendSeconds:
                              type: integer
                              example: 1000000
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/mass-messages?endDate=2026-02-05%2011%3A06%3A57&limit=10'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Engagement / Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/engagement/messages/direct-messages':
    get:
      summary: 'Direct Messages'
      operationId: directMessages
      description: 'List sent direct messages with engagement stats (sent, viewed, purchased, etc.).'
      parameters:
        -
          in: query
          name: startDate
          description: 'The earliest message to retrieve. Keep empty to get all.'
          example: '2026-01-07 00:00:00'
          required: false
          schema:
            type: string
            description: 'The earliest message to retrieve. Keep empty to get all.'
            example: '2026-01-07 00:00:00'
        -
          in: query
          name: endDate
          description: 'The latest message to retrieve. Keep empty to get all. MUST BE DATE AFTER `startDate`. This is also used for pagination.'
          example: '2026-02-06 01:26:15'
          required: false
          schema:
            type: string
            description: 'The latest message to retrieve. Keep empty to get all. MUST BE DATE AFTER `startDate`. This is also used for pagination.'
            example: '2026-02-06 01:26:15'
        -
          in: query
          name: limit
          description: 'Number of messages to return (default = 10)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of messages to return (default = 10)'
            example: 10
        -
          in: query
          name: query
          description: 'Optionally, filter by message text.'
          example: sciss
          required: false
          schema:
            type: string
            description: 'Optionally, filter by message text.'
            example: sciss
        -
          in: query
          name: offset
          description: 'Optional offset for manual pagination.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Optional offset for manual pagination.'
            example: 0
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: true
                    items:
                      -
                        id: 2233445566
                        date: '2026-02-06T01:20:15+00:00'
                        responseType: message
                        text: '<p>SCISSORS</p>'
                        rawText: SCISSORS
                        giphyId: null
                        isFree: false
                        isMediaReady: true
                        mediaCount: 1
                        media:
                          -
                            id: 3344556677
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-03-30T23:06:00+00:00'
                            isReady: true
                            files:
                              full:
                                url: 'https://cdn.example.com/files/placeholder/image.jpg'
                                width: 2801
                                height: 3735
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn.example.com/files/placeholder/thumb.jpg'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn.example.com/files/placeholder/preview.jpg'
                                width: 960
                                height: 1281
                                size: 0
                              squarePreview:
                                url: 'https://cdn.example.com/files/placeholder/square.jpg'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              '240': null
                              '720': null
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        viewedCount: 0
                        sentCount: 1
                        isCanceled: false
                        template: direct
                        messageId: 4455667788990
                        toUserId: 55667788
                        canUnsend: true
                        unsendSeconds: 1000000
                        price: '29.99'
                        purchasedCount: 0
                        canSendMessageToBuyers: false
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/direct-messages?endDate=2026-02-06%2002%3A53%3A05&limit=10'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: true
                      items:
                        type: array
                        example:
                          -
                            id: 2233445566
                            date: '2026-02-06T01:20:15+00:00'
                            responseType: message
                            text: '<p>SCISSORS</p>'
                            rawText: SCISSORS
                            giphyId: null
                            isFree: false
                            isMediaReady: true
                            mediaCount: 1
                            media:
                              -
                                id: 3344556677
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: '2025-03-30T23:06:00+00:00'
                                isReady: true
                                files:
                                  full:
                                    url: 'https://cdn.example.com/files/placeholder/image.jpg'
                                    width: 2801
                                    height: 3735
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: 'https://cdn.example.com/files/placeholder/thumb.jpg'
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: 'https://cdn.example.com/files/placeholder/preview.jpg'
                                    width: 960
                                    height: 1281
                                    size: 0
                                  squarePreview:
                                    url: 'https://cdn.example.com/files/placeholder/square.jpg'
                                    width: 960
                                    height: 960
                                    size: 0
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  240: null
                                  720: null
                            previews: []
                            isTip: false
                            isReportedByMe: false
                            viewedCount: 0
                            sentCount: 1
                            isCanceled: false
                            template: direct
                            messageId: 4455667788990
                            toUserId: 55667788
                            canUnsend: true
                            unsendSeconds: 1000000
                            price: '29.99'
                            purchasedCount: 0
                            canSendMessageToBuyers: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 2233445566
                            date:
                              type: string
                              example: '2026-02-06T01:20:15+00:00'
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: '<p>SCISSORS</p>'
                            rawText:
                              type: string
                              example: SCISSORS
                            giphyId:
                              type: string
                              example: null
                            isFree:
                              type: boolean
                              example: false
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 1
                            media:
                              type: array
                              example:
                                -
                                  id: 3344556677
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: '2025-03-30T23:06:00+00:00'
                                  isReady: true
                                  files:
                                    full:
                                      url: 'https://cdn.example.com/files/placeholder/image.jpg'
                                      width: 2801
                                      height: 3735
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: 'https://cdn.example.com/files/placeholder/thumb.jpg'
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: 'https://cdn.example.com/files/placeholder/preview.jpg'
                                      width: 960
                                      height: 1281
                                      size: 0
                                    squarePreview:
                                      url: 'https://cdn.example.com/files/placeholder/square.jpg'
                                      width: 960
                                      height: 960
                                      size: 0
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    240: null
                                    720: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 3344556677
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: '2025-03-30T23:06:00+00:00'
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full: { type: object, properties: { url: { type: string, example: 'https://cdn.example.com/files/placeholder/image.jpg' }, width: { type: integer, example: 2801 }, height: { type: integer, example: 3735 }, size: { type: integer, example: 0 }, sources: { type: array, example: [] } } }
                                      thumb: { type: object, properties: { url: { type: string, example: 'https://cdn.example.com/files/placeholder/thumb.jpg' }, width: { type: integer, example: 300 }, height: { type: integer, example: 300 }, size: { type: integer, example: 0 } } }
                                      preview: { type: object, properties: { url: { type: string, example: 'https://cdn.example.com/files/placeholder/preview.jpg' }, width: { type: integer, example: 960 }, height: { type: integer, example: 1281 }, size: { type: integer, example: 0 } } }
                                      squarePreview: { type: object, properties: { url: { type: string, example: 'https://cdn.example.com/files/placeholder/square.jpg' }, width: { type: integer, example: 960 }, height: { type: integer, example: 960 }, size: { type: integer, example: 0 } } }
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      240: { type: string, example: null }
                                      720: { type: string, example: null }
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            viewedCount:
                              type: integer
                              example: 0
                            sentCount:
                              type: integer
                              example: 1
                            isCanceled:
                              type: boolean
                              example: false
                            template:
                              type: string
                              example: direct
                            messageId:
                              type: integer
                              example: 4455667788990
                            toUserId:
                              type: integer
                              example: 55667788
                            canUnsend:
                              type: boolean
                              example: true
                            unsendSeconds:
                              type: integer
                              example: 1000000
                            price:
                              type: string
                              example: '29.99'
                            purchasedCount:
                              type: integer
                              example: 0
                            canSendMessageToBuyers:
                              type: boolean
                              example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/direct-messages?endDate=2026-02-06%2002%3A53%3A05&limit=10'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Engagement / Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/engagement/messages/mass-messages/chart':
    get:
      summary: 'Mass Messages Chart'
      operationId: massMessagesChart
      description: 'Get engagement chart metrics for mass messages: sent count and purchase amount over time.'
      parameters:
        -
          in: query
          name: startDate
          description: 'Start of the chart window in `Y-m-d H:i:s` format.'
          example: '2026-01-07 00:00:00'
          required: false
          schema:
            type: string
            description: 'Start of the chart window in `Y-m-d H:i:s` format.'
            example: '2026-01-07 00:00:00'
        -
          in: query
          name: endDate
          description: 'End of the chart window in `Y-m-d H:i:s` format. Must be after `startDate`.'
          example: '2026-02-06 22:19:59'
          required: false
          schema:
            type: string
            description: 'End of the chart window in `Y-m-d H:i:s` format. Must be after `startDate`.'
            example: '2026-02-06 22:19:59'
        -
          in: query
          name: withTotal
          description: 'Include `total` and `delta` aggregates in the response. Defaults to `true`.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Include `total` and `delta` aggregates in the response. Defaults to `true`.'
            example: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    group_messages:
                      chart:
                        -
                          date: '2026-01-07T00:00:00+00:00'
                          count: 8
                        -
                          date: '2026-01-08T00:00:00+00:00'
                          count: 5
                        -
                          date: '2026-01-09T00:00:00+00:00'
                          count: 10
                        -
                          date: '2026-01-10T00:00:00+00:00'
                          count: 7
                        -
                          date: '2026-01-11T00:00:00+00:00'
                          count: 9
                        -
                          date: '2026-01-12T00:00:00+00:00'
                          count: 11
                        -
                          date: '2026-01-13T00:00:00+00:00'
                          count: 6
                        -
                          date: '2026-01-14T00:00:00+00:00'
                          count: 9
                        -
                          date: '2026-01-15T00:00:00+00:00'
                          count: 9
                        -
                          date: '2026-01-16T00:00:00+00:00'
                          count: 12
                        -
                          date: '2026-01-17T00:00:00+00:00'
                          count: 8
                        -
                          date: '2026-01-18T00:00:00+00:00'
                          count: 9
                        -
                          date: '2026-01-19T00:00:00+00:00'
                          count: 8
                        -
                          date: '2026-01-20T00:00:00+00:00'
                          count: 5
                        -
                          date: '2026-01-21T00:00:00+00:00'
                          count: 8
                        -
                          date: '2026-01-22T00:00:00+00:00'
                          count: 11
                        -
                          date: '2026-01-23T00:00:00+00:00'
                          count: 9
                        -
                          date: '2026-01-24T00:00:00+00:00'
                          count: 8
                        -
                          date: '2026-01-25T00:00:00+00:00'
                          count: 8
                        -
                          date: '2026-01-26T00:00:00+00:00'
                          count: 10
                        -
                          date: '2026-01-27T00:00:00+00:00'
                          count: 5
                        -
                          date: '2026-01-28T00:00:00+00:00'
                          count: 7
                        -
                          date: '2026-01-29T00:00:00+00:00'
                          count: 6
                        -
                          date: '2026-01-30T00:00:00+00:00'
                          count: 9
                        -
                          date: '2026-01-31T00:00:00+00:00'
                          count: 4
                        -
                          date: '2026-02-01T00:00:00+00:00'
                          count: 6
                        -
                          date: '2026-02-02T00:00:00+00:00'
                          count: 12
                        -
                          date: '2026-02-03T00:00:00+00:00'
                          count: 6
                        -
                          date: '2026-02-04T00:00:00+00:00'
                          count: 10
                        -
                          date: '2026-02-05T00:00:00+00:00'
                          count: 13
                        -
                          date: '2026-02-06T00:00:00+00:00'
                          count: 8
                      total: 256
                      delta: 32.6
                    group_messages_purchases:
                      chart:
                        -
                          date: '2026-01-07T00:00:00+00:00'
                          count: 846.54
                        -
                          date: '2026-01-08T00:00:00+00:00'
                          count: 549.11
                        -
                          date: '2026-01-09T00:00:00+00:00'
                          count: 1665.94
                        -
                          date: '2026-01-10T00:00:00+00:00'
                          count: 1063.36
                        -
                          date: '2026-01-11T00:00:00+00:00'
                          count: 1368.39
                        -
                          date: '2026-01-12T00:00:00+00:00'
                          count: 1207.98
                        -
                          date: '2026-01-13T00:00:00+00:00'
                          count: 1067.6
                        -
                          date: '2026-01-14T00:00:00+00:00'
                          count: 1009.73
                        -
                          date: '2026-01-15T00:00:00+00:00'
                          count: 548.28
                        -
                          date: '2026-01-16T00:00:00+00:00'
                          count: 1225.95
                        -
                          date: '2026-01-17T00:00:00+00:00'
                          count: 729.63
                        -
                          date: '2026-01-18T00:00:00+00:00'
                          count: 1031.37
                        -
                          date: '2026-01-19T00:00:00+00:00'
                          count: 1030.77
                        -
                          date: '2026-01-20T00:00:00+00:00'
                          count: 664.54
                        -
                          date: '2026-01-21T00:00:00+00:00'
                          count: 989.29
                        -
                          date: '2026-01-22T00:00:00+00:00'
                          count: 1208.15
                        -
                          date: '2026-01-23T00:00:00+00:00'
                          count: 981.15
                        -
                          date: '2026-01-24T00:00:00+00:00'
                          count: 807.61
                        -
                          date: '2026-01-25T00:00:00+00:00'
                          count: 1343.55
                        -
                          date: '2026-01-26T00:00:00+00:00'
                          count: 1040.85
                        -
                          date: '2026-01-27T00:00:00+00:00'
                          count: 468.98
                        -
                          date: '2026-01-28T00:00:00+00:00'
                          count: 1515.54
                        -
                          date: '2026-01-29T00:00:00+00:00'
                          count: 1497.24
                        -
                          date: '2026-01-30T00:00:00+00:00'
                          count: 1331.33
                        -
                          date: '2026-01-31T00:00:00+00:00'
                          count: 938.93
                        -
                          date: '2026-02-01T00:00:00+00:00'
                          count: 372.78
                        -
                          date: '2026-02-02T00:00:00+00:00'
                          count: 780.88
                        -
                          date: '2026-02-03T00:00:00+00:00'
                          count: 521.2
                        -
                          date: '2026-02-04T00:00:00+00:00'
                          count: 1409.73
                        -
                          date: '2026-02-05T00:00:00+00:00'
                          count: 1330.83
                        -
                          date: '2026-02-06T00:00:00+00:00'
                          count: 1504.63
                      total: 32131
                      delta: -1.7
                  _meta:
                    _credits:
                      used: 1
                      balance: 11270561
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      group_messages:
                        type: object
                        properties:
                          chart:
                            type: array
                            example:
                              -
                                date: '2026-01-07T00:00:00+00:00'
                                count: 8
                              -
                                date: '2026-01-08T00:00:00+00:00'
                                count: 5
                              -
                                date: '2026-01-09T00:00:00+00:00'
                                count: 10
                              -
                                date: '2026-01-10T00:00:00+00:00'
                                count: 7
                              -
                                date: '2026-01-11T00:00:00+00:00'
                                count: 9
                              -
                                date: '2026-01-12T00:00:00+00:00'
                                count: 11
                              -
                                date: '2026-01-13T00:00:00+00:00'
                                count: 6
                              -
                                date: '2026-01-14T00:00:00+00:00'
                                count: 9
                              -
                                date: '2026-01-15T00:00:00+00:00'
                                count: 9
                              -
                                date: '2026-01-16T00:00:00+00:00'
                                count: 12
                              -
                                date: '2026-01-17T00:00:00+00:00'
                                count: 8
                              -
                                date: '2026-01-18T00:00:00+00:00'
                                count: 9
                              -
                                date: '2026-01-19T00:00:00+00:00'
                                count: 8
                              -
                                date: '2026-01-20T00:00:00+00:00'
                                count: 5
                              -
                                date: '2026-01-21T00:00:00+00:00'
                                count: 8
                              -
                                date: '2026-01-22T00:00:00+00:00'
                                count: 11
                              -
                                date: '2026-01-23T00:00:00+00:00'
                                count: 9
                              -
                                date: '2026-01-24T00:00:00+00:00'
                                count: 8
                              -
                                date: '2026-01-25T00:00:00+00:00'
                                count: 8
                              -
                                date: '2026-01-26T00:00:00+00:00'
                                count: 10
                              -
                                date: '2026-01-27T00:00:00+00:00'
                                count: 5
                              -
                                date: '2026-01-28T00:00:00+00:00'
                                count: 7
                              -
                                date: '2026-01-29T00:00:00+00:00'
                                count: 6
                              -
                                date: '2026-01-30T00:00:00+00:00'
                                count: 9
                              -
                                date: '2026-01-31T00:00:00+00:00'
                                count: 4
                              -
                                date: '2026-02-01T00:00:00+00:00'
                                count: 6
                              -
                                date: '2026-02-02T00:00:00+00:00'
                                count: 12
                              -
                                date: '2026-02-03T00:00:00+00:00'
                                count: 6
                              -
                                date: '2026-02-04T00:00:00+00:00'
                                count: 10
                              -
                                date: '2026-02-05T00:00:00+00:00'
                                count: 13
                              -
                                date: '2026-02-06T00:00:00+00:00'
                                count: 8
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2026-01-07T00:00:00+00:00'
                                count:
                                  type: integer
                                  example: 8
                          total:
                            type: integer
                            example: 256
                          delta:
                            type: number
                            example: 32.6
                      group_messages_purchases:
                        type: object
                        properties:
                          chart:
                            type: array
                            example:
                              -
                                date: '2026-01-07T00:00:00+00:00'
                                count: 846.54
                              -
                                date: '2026-01-08T00:00:00+00:00'
                                count: 549.11
                              -
                                date: '2026-01-09T00:00:00+00:00'
                                count: 1665.94
                              -
                                date: '2026-01-10T00:00:00+00:00'
                                count: 1063.36
                              -
                                date: '2026-01-11T00:00:00+00:00'
                                count: 1368.39
                              -
                                date: '2026-01-12T00:00:00+00:00'
                                count: 1207.98
                              -
                                date: '2026-01-13T00:00:00+00:00'
                                count: 1067.6
                              -
                                date: '2026-01-14T00:00:00+00:00'
                                count: 1009.73
                              -
                                date: '2026-01-15T00:00:00+00:00'
                                count: 548.28
                              -
                                date: '2026-01-16T00:00:00+00:00'
                                count: 1225.95
                              -
                                date: '2026-01-17T00:00:00+00:00'
                                count: 729.63
                              -
                                date: '2026-01-18T00:00:00+00:00'
                                count: 1031.37
                              -
                                date: '2026-01-19T00:00:00+00:00'
                                count: 1030.77
                              -
                                date: '2026-01-20T00:00:00+00:00'
                                count: 664.54
                              -
                                date: '2026-01-21T00:00:00+00:00'
                                count: 989.29
                              -
                                date: '2026-01-22T00:00:00+00:00'
                                count: 1208.15
                              -
                                date: '2026-01-23T00:00:00+00:00'
                                count: 981.15
                              -
                                date: '2026-01-24T00:00:00+00:00'
                                count: 807.61
                              -
                                date: '2026-01-25T00:00:00+00:00'
                                count: 1343.55
                              -
                                date: '2026-01-26T00:00:00+00:00'
                                count: 1040.85
                              -
                                date: '2026-01-27T00:00:00+00:00'
                                count: 468.98
                              -
                                date: '2026-01-28T00:00:00+00:00'
                                count: 1515.54
                              -
                                date: '2026-01-29T00:00:00+00:00'
                                count: 1497.24
                              -
                                date: '2026-01-30T00:00:00+00:00'
                                count: 1331.33
                              -
                                date: '2026-01-31T00:00:00+00:00'
                                count: 938.93
                              -
                                date: '2026-02-01T00:00:00+00:00'
                                count: 372.78
                              -
                                date: '2026-02-02T00:00:00+00:00'
                                count: 780.88
                              -
                                date: '2026-02-03T00:00:00+00:00'
                                count: 521.2
                              -
                                date: '2026-02-04T00:00:00+00:00'
                                count: 1409.73
                              -
                                date: '2026-02-05T00:00:00+00:00'
                                count: 1330.83
                              -
                                date: '2026-02-06T00:00:00+00:00'
                                count: 1504.63
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2026-01-07T00:00:00+00:00'
                                count:
                                  type: number
                                  example: 846.54
                          total:
                            type: integer
                            example: 32131
                          delta:
                            type: number
                            example: -1.7
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 11270561
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Engagement / Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/engagement/messages/direct-messages/chart':
    get:
      summary: 'Direct Messages Chart'
      operationId: directMessagesChart
      description: 'Get engagement chart metrics for direct messages: sent count and purchase amount over time.'
      parameters:
        -
          in: query
          name: startDate
          description: 'Start of the chart window in `Y-m-d H:i:s` format.'
          example: '2026-01-07 00:00:00'
          required: false
          schema:
            type: string
            description: 'Start of the chart window in `Y-m-d H:i:s` format.'
            example: '2026-01-07 00:00:00'
        -
          in: query
          name: endDate
          description: 'End of the chart window in `Y-m-d H:i:s` format. Must be after `startDate`.'
          example: '2026-02-06 22:19:59'
          required: false
          schema:
            type: string
            description: 'End of the chart window in `Y-m-d H:i:s` format. Must be after `startDate`.'
            example: '2026-02-06 22:19:59'
        -
          in: query
          name: withTotal
          description: 'Include `total` and `delta` aggregates in the response. Defaults to `true`.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Include `total` and `delta` aggregates in the response. Defaults to `true`.'
            example: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    direct_messages:
                      chart:
                        -
                          date: '2026-01-07T00:00:00+00:00'
                          count: 436
                        -
                          date: '2026-01-08T00:00:00+00:00'
                          count: 403
                        -
                          date: '2026-01-09T00:00:00+00:00'
                          count: 587
                        -
                          date: '2026-01-10T00:00:00+00:00'
                          count: 543
                        -
                          date: '2026-01-11T00:00:00+00:00'
                          count: 622
                        -
                          date: '2026-01-12T00:00:00+00:00'
                          count: 538
                        -
                          date: '2026-01-13T00:00:00+00:00'
                          count: 326
                        -
                          date: '2026-01-14T00:00:00+00:00'
                          count: 569
                        -
                          date: '2026-01-15T00:00:00+00:00'
                          count: 478
                        -
                          date: '2026-01-16T00:00:00+00:00'
                          count: 506
                        -
                          date: '2026-01-17T00:00:00+00:00'
                          count: 611
                        -
                          date: '2026-01-18T00:00:00+00:00'
                          count: 593
                        -
                          date: '2026-01-19T00:00:00+00:00'
                          count: 875
                        -
                          date: '2026-01-20T00:00:00+00:00'
                          count: 1178
                        -
                          date: '2026-01-21T00:00:00+00:00'
                          count: 1331
                        -
                          date: '2026-01-22T00:00:00+00:00'
                          count: 1277
                        -
                          date: '2026-01-23T00:00:00+00:00'
                          count: 1153
                        -
                          date: '2026-01-24T00:00:00+00:00'
                          count: 1255
                        -
                          date: '2026-01-25T00:00:00+00:00'
                          count: 1179
                        -
                          date: '2026-01-26T00:00:00+00:00'
                          count: 1147
                        -
                          date: '2026-01-27T00:00:00+00:00'
                          count: 905
                        -
                          date: '2026-01-28T00:00:00+00:00'
                          count: 1467
                        -
                          date: '2026-01-29T00:00:00+00:00'
                          count: 1681
                        -
                          date: '2026-01-30T00:00:00+00:00'
                          count: 1827
                        -
                          date: '2026-01-31T00:00:00+00:00'
                          count: 1501
                        -
                          date: '2026-02-01T00:00:00+00:00'
                          count: 935
                        -
                          date: '2026-02-02T00:00:00+00:00'
                          count: 922
                        -
                          date: '2026-02-03T00:00:00+00:00'
                          count: 1059
                        -
                          date: '2026-02-04T00:00:00+00:00'
                          count: 1124
                        -
                          date: '2026-02-05T00:00:00+00:00'
                          count: 1111
                        -
                          date: '2026-02-06T00:00:00+00:00'
                          count: 1155
                      total: 29294
                      delta: 71
                    direct_messages_purchases:
                      chart:
                        -
                          date: '2026-01-07T00:00:00+00:00'
                          count: 4229.47
                        -
                          date: '2026-01-08T00:00:00+00:00'
                          count: 3501.2
                        -
                          date: '2026-01-09T00:00:00+00:00'
                          count: 7119.34
                        -
                          date: '2026-01-10T00:00:00+00:00'
                          count: 5141.29
                        -
                          date: '2026-01-11T00:00:00+00:00'
                          count: 8131.15
                        -
                          date: '2026-01-12T00:00:00+00:00'
                          count: 5387.46
                        -
                          date: '2026-01-13T00:00:00+00:00'
                          count: 2680.16
                        -
                          date: '2026-01-14T00:00:00+00:00'
                          count: 3728.25
                        -
                          date: '2026-01-15T00:00:00+00:00'
                          count: 4577.14
                        -
                          date: '2026-01-16T00:00:00+00:00'
                          count: 4369.77
                        -
                          date: '2026-01-17T00:00:00+00:00'
                          count: 7509.09
                        -
                          date: '2026-01-18T00:00:00+00:00'
                          count: 3741.5
                        -
                          date: '2026-01-19T00:00:00+00:00'
                          count: 3089.89
                        -
                          date: '2026-01-20T00:00:00+00:00'
                          count: 5318.68
                        -
                          date: '2026-01-21T00:00:00+00:00'
                          count: 6722.56
                        -
                          date: '2026-01-22T00:00:00+00:00'
                          count: 4585.53
                        -
                          date: '2026-01-23T00:00:00+00:00'
                          count: 8163.06
                        -
                          date: '2026-01-24T00:00:00+00:00'
                          count: 4872.21
                        -
                          date: '2026-01-25T00:00:00+00:00'
                          count: 5804.55
                        -
                          date: '2026-01-26T00:00:00+00:00'
                          count: 5393.57
                        -
                          date: '2026-01-27T00:00:00+00:00'
                          count: 3874.12
                        -
                          date: '2026-01-28T00:00:00+00:00'
                          count: 6735.14
                        -
                          date: '2026-01-29T00:00:00+00:00'
                          count: 7908.03
                        -
                          date: '2026-01-30T00:00:00+00:00'
                          count: 11120.55
                        -
                          date: '2026-01-31T00:00:00+00:00'
                          count: 12434.52
                        -
                          date: '2026-02-01T00:00:00+00:00'
                          count: 6016.15
                        -
                          date: '2026-02-02T00:00:00+00:00'
                          count: 3772.66
                        -
                          date: '2026-02-03T00:00:00+00:00'
                          count: 5710.38
                        -
                          date: '2026-02-04T00:00:00+00:00'
                          count: 5652.75
                        -
                          date: '2026-02-05T00:00:00+00:00'
                          count: 6934.73
                        -
                          date: '2026-02-06T00:00:00+00:00'
                          count: 5046.19
                      total: 179903.2
                      delta: 26.6
                  _meta:
                    _credits:
                      used: 1
                      balance: 11270560
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      direct_messages:
                        type: object
                        properties:
                          chart:
                            type: array
                            example:
                              -
                                date: '2026-01-07T00:00:00+00:00'
                                count: 436
                              -
                                date: '2026-01-08T00:00:00+00:00'
                                count: 403
                              -
                                date: '2026-01-09T00:00:00+00:00'
                                count: 587
                              -
                                date: '2026-01-10T00:00:00+00:00'
                                count: 543
                              -
                                date: '2026-01-11T00:00:00+00:00'
                                count: 622
                              -
                                date: '2026-01-12T00:00:00+00:00'
                                count: 538
                              -
                                date: '2026-01-13T00:00:00+00:00'
                                count: 326
                              -
                                date: '2026-01-14T00:00:00+00:00'
                                count: 569
                              -
                                date: '2026-01-15T00:00:00+00:00'
                                count: 478
                              -
                                date: '2026-01-16T00:00:00+00:00'
                                count: 506
                              -
                                date: '2026-01-17T00:00:00+00:00'
                                count: 611
                              -
                                date: '2026-01-18T00:00:00+00:00'
                                count: 593
                              -
                                date: '2026-01-19T00:00:00+00:00'
                                count: 875
                              -
                                date: '2026-01-20T00:00:00+00:00'
                                count: 1178
                              -
                                date: '2026-01-21T00:00:00+00:00'
                                count: 1331
                              -
                                date: '2026-01-22T00:00:00+00:00'
                                count: 1277
                              -
                                date: '2026-01-23T00:00:00+00:00'
                                count: 1153
                              -
                                date: '2026-01-24T00:00:00+00:00'
                                count: 1255
                              -
                                date: '2026-01-25T00:00:00+00:00'
                                count: 1179
                              -
                                date: '2026-01-26T00:00:00+00:00'
                                count: 1147
                              -
                                date: '2026-01-27T00:00:00+00:00'
                                count: 905
                              -
                                date: '2026-01-28T00:00:00+00:00'
                                count: 1467
                              -
                                date: '2026-01-29T00:00:00+00:00'
                                count: 1681
                              -
                                date: '2026-01-30T00:00:00+00:00'
                                count: 1827
                              -
                                date: '2026-01-31T00:00:00+00:00'
                                count: 1501
                              -
                                date: '2026-02-01T00:00:00+00:00'
                                count: 935
                              -
                                date: '2026-02-02T00:00:00+00:00'
                                count: 922
                              -
                                date: '2026-02-03T00:00:00+00:00'
                                count: 1059
                              -
                                date: '2026-02-04T00:00:00+00:00'
                                count: 1124
                              -
                                date: '2026-02-05T00:00:00+00:00'
                                count: 1111
                              -
                                date: '2026-02-06T00:00:00+00:00'
                                count: 1155
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2026-01-07T00:00:00+00:00'
                                count:
                                  type: integer
                                  example: 436
                          total:
                            type: integer
                            example: 29294
                          delta:
                            type: integer
                            example: 71
                      direct_messages_purchases:
                        type: object
                        properties:
                          chart:
                            type: array
                            example:
                              -
                                date: '2026-01-07T00:00:00+00:00'
                                count: 4229.47
                              -
                                date: '2026-01-08T00:00:00+00:00'
                                count: 3501.2
                              -
                                date: '2026-01-09T00:00:00+00:00'
                                count: 7119.34
                              -
                                date: '2026-01-10T00:00:00+00:00'
                                count: 5141.29
                              -
                                date: '2026-01-11T00:00:00+00:00'
                                count: 8131.15
                              -
                                date: '2026-01-12T00:00:00+00:00'
                                count: 5387.46
                              -
                                date: '2026-01-13T00:00:00+00:00'
                                count: 2680.16
                              -
                                date: '2026-01-14T00:00:00+00:00'
                                count: 3728.25
                              -
                                date: '2026-01-15T00:00:00+00:00'
                                count: 4577.14
                              -
                                date: '2026-01-16T00:00:00+00:00'
                                count: 4369.77
                              -
                                date: '2026-01-17T00:00:00+00:00'
                                count: 7509.09
                              -
                                date: '2026-01-18T00:00:00+00:00'
                                count: 3741.5
                              -
                                date: '2026-01-19T00:00:00+00:00'
                                count: 3089.89
                              -
                                date: '2026-01-20T00:00:00+00:00'
                                count: 5318.68
                              -
                                date: '2026-01-21T00:00:00+00:00'
                                count: 6722.56
                              -
                                date: '2026-01-22T00:00:00+00:00'
                                count: 4585.53
                              -
                                date: '2026-01-23T00:00:00+00:00'
                                count: 8163.06
                              -
                                date: '2026-01-24T00:00:00+00:00'
                                count: 4872.21
                              -
                                date: '2026-01-25T00:00:00+00:00'
                                count: 5804.55
                              -
                                date: '2026-01-26T00:00:00+00:00'
                                count: 5393.57
                              -
                                date: '2026-01-27T00:00:00+00:00'
                                count: 3874.12
                              -
                                date: '2026-01-28T00:00:00+00:00'
                                count: 6735.14
                              -
                                date: '2026-01-29T00:00:00+00:00'
                                count: 7908.03
                              -
                                date: '2026-01-30T00:00:00+00:00'
                                count: 11120.55
                              -
                                date: '2026-01-31T00:00:00+00:00'
                                count: 12434.52
                              -
                                date: '2026-02-01T00:00:00+00:00'
                                count: 6016.15
                              -
                                date: '2026-02-02T00:00:00+00:00'
                                count: 3772.66
                              -
                                date: '2026-02-03T00:00:00+00:00'
                                count: 5710.38
                              -
                                date: '2026-02-04T00:00:00+00:00'
                                count: 5652.75
                              -
                                date: '2026-02-05T00:00:00+00:00'
                                count: 6934.73
                              -
                                date: '2026-02-06T00:00:00+00:00'
                                count: 5046.19
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2026-01-07T00:00:00+00:00'
                                count:
                                  type: number
                                  example: 4229.47
                          total:
                            type: number
                            example: 179903.2
                          delta:
                            type: number
                            example: 26.6
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 11270560
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Engagement / Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/engagement/messages/top-message':
    get:
      summary: 'Top Message'
      operationId: topMessage
      description: 'Get the top performing message by purchases in the selected timeframe.'
      parameters:
        -
          in: query
          name: startDate
          description: 'The start date for the period. Keep empty to retrieve from the model start date.'
          example: '2026-01-07 00:00:00'
          required: false
          schema:
            type: string
            description: 'The start date for the period. Keep empty to retrieve from the model start date.'
            example: '2026-01-07 00:00:00'
        -
          in: query
          name: endDate
          description: 'The end date for the period. Keep empty to retrieve until now. MUST BE DATE AFTER `startDate`.'
          example: '2026-02-06 01:26:15'
          required: false
          schema:
            type: string
            description: 'The end date for the period. Keep empty to retrieve until now. MUST BE DATE AFTER `startDate`.'
            example: '2026-02-06 01:26:15'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    purchases:
                      id: 6677889900
                      date: '2024-06-30T12:53:42+00:00'
                      responseType: message
                      text: "This is the hardest i've ever been fucked... would you make me cum more than this?? 🥵💦"
                      rawText: "This is the hardest i've ever been fucked... would you make me cum more than this?? 🥵💦"
                      giphyId: null
                      isFree: false
                      isMediaReady: true
                      mediaCount: 1
                      media:
                        -
                          id: 7788990011
                          type: video
                          convertedToVideo: false
                          canView: true
                          hasError: false
                          createdAt: '2023-01-31T13:14:15+00:00'
                          isReady: true
                          files:
                            full:
                              url: 'https://cdn.example.com/files/placeholder/video_source.mp4'
                              width: 1080
                              height: 1920
                              size: 0
                              sources: []
                            thumb:
                              url: 'https://cdn.example.com/files/placeholder/thumb.jpg'
                              width: 300
                              height: 300
                              size: 0
                            preview:
                              url: 'https://cdn.example.com/files/placeholder/preview.jpg'
                              width: 960
                              height: 1707
                              size: 0
                            squarePreview:
                              url: 'https://cdn.example.com/files/placeholder/square.jpg'
                              width: 960
                              height: 960
                              size: 0
                          duration: 528
                          hasCustomPreview: false
                          videoSources:
                            '240': 'https://cdn.example.com/files/placeholder/video_240p.mp4'
                            '720': 'https://cdn.example.com/files/placeholder/video_720p.mp4'
                      previews: []
                      isTip: false
                      isReportedByMe: false
                      viewedCount: 9360
                      sentCount: 15802
                      isCanceled: true
                      template: group
                      canUnsend: false
                      unsendSeconds: 0
                      price: '98.00'
                      purchasedCount: 146
                      canSendMessageToBuyers: true
                      totalRevenueGenerated: '14308.00'
                      relationships:
                        buyers:
                          href: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/6677889900/buyers?limit=10&offset=0&skip_users_dups=1&marker=0'
                          method: GET
                  _meta:
                    _credits:
                      used: 1
                      balance: 11335469
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      purchases:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 6677889900
                          date:
                            type: string
                            example: '2024-06-30T12:53:42+00:00'
                          responseType:
                            type: string
                            example: message
                          text:
                            type: string
                            example: "This is the hardest i've ever been fucked... would you make me cum more than this?? 🥵💦"
                          rawText:
                            type: string
                            example: "This is the hardest i've ever been fucked... would you make me cum more than this?? 🥵💦"
                          giphyId:
                            type: string
                            example: null
                          isFree:
                            type: boolean
                            example: false
                          isMediaReady:
                            type: boolean
                            example: true
                          mediaCount:
                            type: integer
                            example: 1
                          media:
                            type: array
                            example:
                              -
                                id: 7788990011
                                type: video
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: '2023-01-31T13:14:15+00:00'
                                isReady: true
                                files:
                                  full:
                                    url: 'https://cdn.example.com/files/placeholder/video_source.mp4'
                                    width: 1080
                                    height: 1920
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: 'https://cdn.example.com/files/placeholder/thumb.jpg'
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: 'https://cdn.example.com/files/placeholder/preview.jpg'
                                    width: 960
                                    height: 1707
                                    size: 0
                                  squarePreview:
                                    url: 'https://cdn.example.com/files/placeholder/square.jpg'
                                    width: 960
                                    height: 960
                                    size: 0
                                duration: 528
                                hasCustomPreview: false
                                videoSources:
                                  240: 'https://cdn.example.com/files/placeholder/video_240p.mp4'
                                  720: 'https://cdn.example.com/files/placeholder/video_720p.mp4'
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 7788990011
                                type:
                                  type: string
                                  example: video
                                convertedToVideo:
                                  type: boolean
                                  example: false
                                canView:
                                  type: boolean
                                  example: true
                                hasError:
                                  type: boolean
                                  example: false
                                createdAt:
                                  type: string
                                  example: '2023-01-31T13:14:15+00:00'
                                isReady:
                                  type: boolean
                                  example: true
                                files:
                                  type: object
                                  properties:
                                    full:
                                      type: object
                                      properties: { url: { type: string, example: 'https://cdn.example.com/files/placeholder/video_source.mp4' }, width: { type: integer, example: 1080 }, height: { type: integer, example: 1920 }, size: { type: integer, example: 0 }, sources: { type: array, example: [] } }
                                    thumb:
                                      type: object
                                      properties: { url: { type: string, example: 'https://cdn.example.com/files/placeholder/thumb.jpg' }, width: { type: integer, example: 300 }, height: { type: integer, example: 300 }, size: { type: integer, example: 0 } }
                                    preview:
                                      type: object
                                      properties: { url: { type: string, example: 'https://cdn.example.com/files/placeholder/preview.jpg' }, width: { type: integer, example: 960 }, height: { type: integer, example: 1707 }, size: { type: integer, example: 0 } }
                                    squarePreview:
                                      type: object
                                      properties: { url: { type: string, example: 'https://cdn.example.com/files/placeholder/square.jpg' }, width: { type: integer, example: 960 }, height: { type: integer, example: 960 }, size: { type: integer, example: 0 } }
                                duration:
                                  type: integer
                                  example: 528
                                hasCustomPreview:
                                  type: boolean
                                  example: false
                                videoSources:
                                  type: object
                                  properties:
                                    240:
                                      type: string
                                      example: 'https://cdn.example.com/files/placeholder/video_240p.mp4'
                                    720:
                                      type: string
                                      example: 'https://cdn.example.com/files/placeholder/video_720p.mp4'
                          previews:
                            type: array
                            example: []
                          isTip:
                            type: boolean
                            example: false
                          isReportedByMe:
                            type: boolean
                            example: false
                          viewedCount:
                            type: integer
                            example: 9360
                          sentCount:
                            type: integer
                            example: 15802
                          isCanceled:
                            type: boolean
                            example: true
                          template:
                            type: string
                            example: group
                          canUnsend:
                            type: boolean
                            example: false
                          unsendSeconds:
                            type: integer
                            example: 0
                          price:
                            type: string
                            example: '98.00'
                          purchasedCount:
                            type: integer
                            example: 146
                          canSendMessageToBuyers:
                            type: boolean
                            example: true
                          totalRevenueGenerated:
                            type: string
                            example: '14308.00'
                          relationships:
                            type: object
                            properties:
                              buyers:
                                type: object
                                properties:
                                  href:
                                    type: string
                                    example: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXX/engagement/messages/6677889900/buyers?limit=10&offset=0&skip_users_dups=1&marker=0'
                                  method:
                                    type: string
                                    example: GET
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 11335469
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Engagement / Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/engagement/messages/{message_id}/buyers':
    get:
      summary: 'Message Buyers'
      operationId: messageBuyers
      description: 'List buyers for a specific message.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of buyers to return (default = 10)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of buyers to return (default = 10)'
            example: 10
        -
          in: query
          name: offset
          description: 'Offset for pagination (default = 0)'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Offset for pagination (default = 0)'
            example: 0
        -
          in: query
          name: skip_users_dups
          description: 'Skip duplicate users in results (0/1). Default = 1'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Skip duplicate users in results (0/1). Default = 1'
            example: 1
        -
          in: query
          name: skip_users
          description: 'Optional flag for subsequent pages (example: all)'
          example: all
          required: false
          schema:
            type: string
            description: 'Optional flag for subsequent pages (example: all)'
            example: all
        -
          in: query
          name: marker
          description: 'Marker for pagination'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Marker for pagination'
            example: 0
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 35777544
                        name: Newbles
                        username: u35777544
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: 'Doesnt rly like BJ'
                        notice: Solo
                        isActive: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2033-05-03T05:32:54+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: null
                        subscribedOnExpiredNow: true
                        subscribedOnDuration: '10 months'
                        showMediaCount: true
                        lastSeen: '2026-02-05T16:10:14+00:00'
                        canReport: true
                    marker: 957523925
                    hasMore: true
                  _pagination:
                    next_page: 'http://localhost/api/{account}/engagement/messages/34700613157/buyers?offset=10&limit=10&marker=957523925'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 35777544
                            name: Newbles
                            username: u35777544
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: 'Doesnt rly like BJ'
                            notice: Solo
                            isActive: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2033-05-03T05:32:54+00:00'
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: null
                            subscribedOnExpiredNow: true
                            subscribedOnDuration: '10 months'
                            showMediaCount: true
                            lastSeen: '2026-02-05T16:10:14+00:00'
                            canReport: true
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: s
                            avatar:
                              type: string
                              example: null
                            avatarThumbs:
                              type: string
                              example: null
                            header:
                              type: string
                              example: null
                            headerSize:
                              type: string
                              example: null
                            headerThumbs:
                              type: string
                              example: null
                            id:
                              type: integer
                              example: 35777544
                            name:
                              type: string
                              example: Newbles
                            username:
                              type: string
                              example: u35777544
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: false
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            displayName:
                              type: string
                              example: 'Doesnt rly like BJ'
                            notice:
                              type: string
                              example: Solo
                            isActive:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2033-05-03T05:32:54+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: string
                              example: null
                            subscribedOnExpiredNow:
                              type: boolean
                              example: true
                            subscribedOnDuration:
                              type: string
                              example: '10 months'
                            showMediaCount:
                              type: boolean
                              example: true
                            lastSeen:
                              type: string
                              example: '2026-02-05T16:10:14+00:00'
                            canReport:
                              type: boolean
                              example: true
                      marker:
                        type: integer
                        example: 957523925
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'http://localhost/api/{account}/engagement/messages/34700613157/buyers?offset=10&limit=10&marker=957523925'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Engagement / Messages'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: message_id
        description: 'The ID of the message.'
        example: temporibus
        required: true
        schema:
          type: string
  '/api/{account}/fans/all':
    get:
      summary: 'List All Fans'
      operationId: listAllFans
      description: 'Get a paginated list of fans for an Account. Newest fans are first.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of fans to return (1-50). Must be at least 1. Must not be greater than 20.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'Number of fans to return (1-50). Must be at least 1. Must not be greater than 20.'
            example: 20
        -
          in: query
          name: offset
          description: 'Number of fans to skip. Must be at least 0.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Number of fans to skip. Must be at least 0.'
            example: 0
        -
          in: query
          name: type
          description: 'Filter by fan type.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by fan type.'
            example: null
            enum:
              - active
              - expired
              - all
        -
          in: query
          name: filter
          description: ''
          example: []
          required: false
          schema:
            type: object
            description: ''
            example: []
            properties: {  }
        -
          in: query
          name: filter.online
          description: 'Filter by online status (`1` for online fans).'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by online status (`1` for online fans).'
            example: null
            enum:
              - '1'
              - '0'
            nullable: true
        -
          in: query
          name: filter.total_spent
          description: 'Filter by minimum amount total spent by a fan. Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum amount total spent by a fan. Must be at least 0.'
            example: null
        -
          in: query
          name: filter.tips
          description: 'Filter by minimum tips. Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum tips. Must be at least 0.'
            example: null
        -
          in: query
          name: filter.duration
          description: 'Filter by minimum subscription duration (days). Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum subscription duration (days). Must be at least 0.'
            example: null
        -
          in: query
          name: query
          description: 'Search within fan name/username.'
          example: null
          required: false
          schema:
            type: string
            description: 'Search within fan name/username.'
            example: null
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 4.99
                        subscriptionBundles: []
                        displayName: ''
                        notice: ''
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '6 days'
                        listsStates:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: false
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: 'Set to Expire'
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '6 days'
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                          subscribes:
                            -
                              id: 213
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 7
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 4.99
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: '2025-01-01T00:00:00+00:00'
                              offerEnd: '2025-01-01T00:00:00+00:00'
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          -
                            id: 123
                            subscribeDays: 7
                            createdAt: '2025-01-01T00:00:00+00:00'
                            expiredAt: '2025-01-01T00:00:00+00:00'
                            finishedAt: '2025-01-01T00:00:00+00:00'
                            subscriberId: '123'
                            userId: '123'
                    hasMore: true
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 4.99
                            subscriptionBundles: []
                            displayName: ''
                            notice: ''
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '6 days'
                            listsStates:
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: recent
                                type: recent
                                name: 'Recent (last 24 hours)'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: false
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: '2025-01-01T00:00:00+00:00'
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: 'Set to Expire'
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '6 days'
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: '2025-01-01T00:00:00+00:00'
                              recommendations: 0
                              subscribes:
                                -
                                  id: 213
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 7
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 4.99
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: '2025-01-01T00:00:00+00:00'
                                  offerEnd: '2025-01-01T00:00:00+00:00'
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              -
                                id: 123
                                subscribeDays: 7
                                createdAt: '2025-01-01T00:00:00+00:00'
                                expiredAt: '2025-01-01T00:00:00+00:00'
                                finishedAt: '2025-01-01T00:00:00+00:00'
                                subscriberId: '123'
                                userId: '123'
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                            header:
                              type: string
                              example: null
                            headerSize:
                              type: string
                              example: null
                            headerThumbs:
                              type: string
                              example: null
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 4.99
                            subscriptionBundles:
                              type: array
                              example: []
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                            subscribedByExpireDate:
                              type: string
                              example: null
                            subscribedByAutoprolong:
                              type: string
                              example: null
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                            currentSubscribePrice:
                              type: string
                              example: null
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: '6 days'
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: recent
                                  type: recent
                                  name: 'Recent (last 24 hours)'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: 'Set to Expire'
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '6 days'
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 213
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 7
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 4.99
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: '2025-01-01T00:00:00+00:00'
                                      offerEnd: '2025-01-01T00:00:00+00:00'
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 213 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 7 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: number, example: 4.99 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: trial }
                                      offerStart: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      offerEnd: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                -
                                  id: 123
                                  subscribeDays: 7
                                  createdAt: '2025-01-01T00:00:00+00:00'
                                  expiredAt: '2025-01-01T00:00:00+00:00'
                                  finishedAt: '2025-01-01T00:00:00+00:00'
                                  subscriberId: '123'
                                  userId: '123'
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 7
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  expiredAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  finishedAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  subscriberId:
                                    type: string
                                    example: '123'
                                  userId:
                                    type: string
                                    example: '123'
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Fans
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/fans/active':
    get:
      summary: 'List Active Fans'
      operationId: listActiveFans
      description: 'Get a paginated list of fans for an Account. Newest fans are first.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of fans to return (1-50). Must be at least 1. Must not be greater than 20.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'Number of fans to return (1-50). Must be at least 1. Must not be greater than 20.'
            example: 20
        -
          in: query
          name: offset
          description: 'Number of fans to skip. Must be at least 0.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Number of fans to skip. Must be at least 0.'
            example: 0
        -
          in: query
          name: type
          description: 'Filter by fan type.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by fan type.'
            example: null
            enum:
              - active
              - expired
              - all
        -
          in: query
          name: filter
          description: ''
          example: []
          required: false
          schema:
            type: object
            description: ''
            example: []
            properties: {  }
        -
          in: query
          name: filter.online
          description: 'Filter by online status (`1` for online fans).'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by online status (`1` for online fans).'
            example: null
            enum:
              - '1'
              - '0'
            nullable: true
        -
          in: query
          name: filter.total_spent
          description: 'Filter by minimum amount total spent by a fan. Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum amount total spent by a fan. Must be at least 0.'
            example: null
        -
          in: query
          name: filter.tips
          description: 'Filter by minimum tips. Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum tips. Must be at least 0.'
            example: null
        -
          in: query
          name: filter.duration
          description: 'Filter by minimum subscription duration (days). Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum subscription duration (days). Must be at least 0.'
            example: null
        -
          in: query
          name: query
          description: 'Search within fan name/username.'
          example: null
          required: false
          schema:
            type: string
            description: 'Search within fan name/username.'
            example: null
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 4.99
                        subscriptionBundles: []
                        displayName: ''
                        notice: ''
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '6 days'
                        listsStates:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: false
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: 'Set to Expire'
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '6 days'
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 7
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 4.99
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: '2025-01-01T00:00:00+00:00'
                              offerEnd: '2025-01-01T00:00:00+00:00'
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          -
                            id: 123
                            subscribeDays: 7
                            createdAt: '2025-01-01T00:00:00+00:00'
                            expiredAt: '2025-01-01T00:00:00+00:00'
                            finishedAt: '2025-01-01T00:00:00+00:00'
                            subscriberId: '123'
                            userId: '123'
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999840
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 4.99
                            subscriptionBundles: []
                            displayName: ''
                            notice: ''
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '6 days'
                            listsStates:
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: recent
                                type: recent
                                name: 'Recent (last 24 hours)'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: false
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: '2025-01-01T00:00:00+00:00'
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: 'Set to Expire'
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '6 days'
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: '2025-01-01T00:00:00+00:00'
                              recommendations: 0
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 7
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 4.99
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: '2025-01-01T00:00:00+00:00'
                                  offerEnd: '2025-01-01T00:00:00+00:00'
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              -
                                id: 123
                                subscribeDays: 7
                                createdAt: '2025-01-01T00:00:00+00:00'
                                expiredAt: '2025-01-01T00:00:00+00:00'
                                finishedAt: '2025-01-01T00:00:00+00:00'
                                subscriberId: '123'
                                userId: '123'
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                            header:
                              type: string
                              example: null
                            headerSize:
                              type: string
                              example: null
                            headerThumbs:
                              type: string
                              example: null
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 4.99
                            subscriptionBundles:
                              type: array
                              example: []
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                            subscribedByExpireDate:
                              type: string
                              example: null
                            subscribedByAutoprolong:
                              type: string
                              example: null
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                            currentSubscribePrice:
                              type: string
                              example: null
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: '6 days'
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: recent
                                  type: recent
                                  name: 'Recent (last 24 hours)'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: 'Set to Expire'
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '6 days'
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 7
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 4.99
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: '2025-01-01T00:00:00+00:00'
                                      offerEnd: '2025-01-01T00:00:00+00:00'
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 7 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: number, example: 4.99 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: trial }
                                      offerStart: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      offerEnd: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                -
                                  id: 123
                                  subscribeDays: 7
                                  createdAt: '2025-01-01T00:00:00+00:00'
                                  expiredAt: '2025-01-01T00:00:00+00:00'
                                  finishedAt: '2025-01-01T00:00:00+00:00'
                                  subscriberId: '123'
                                  userId: '123'
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 7
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  expiredAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  finishedAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  subscriberId:
                                    type: string
                                    example: '123'
                                  userId:
                                    type: string
                                    example: '123'
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999840
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - Fans
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/fans/expired':
    get:
      summary: 'List Expired Fans'
      operationId: listExpiredFans
      description: 'Get a paginated list of expired fans for an Account. Newest fans are first.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of fans to return (1-50). Must be at least 1. Must not be greater than 20.'
          example: 20
          required: false
          schema:
            type: integer
            description: 'Number of fans to return (1-50). Must be at least 1. Must not be greater than 20.'
            example: 20
        -
          in: query
          name: offset
          description: 'Number of fans to skip. Must be at least 0.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Number of fans to skip. Must be at least 0.'
            example: 0
        -
          in: query
          name: type
          description: 'Filter by fan type.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by fan type.'
            example: null
            enum:
              - active
              - expired
              - all
        -
          in: query
          name: filter
          description: ''
          example: []
          required: false
          schema:
            type: object
            description: ''
            example: []
            properties: {  }
        -
          in: query
          name: filter.online
          description: 'Filter by online status (`1` for online fans).'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by online status (`1` for online fans).'
            example: null
            enum:
              - '1'
              - '0'
            nullable: true
        -
          in: query
          name: filter.total_spent
          description: 'Filter by minimum amount total spent by a fan. Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum amount total spent by a fan. Must be at least 0.'
            example: null
        -
          in: query
          name: filter.tips
          description: 'Filter by minimum tips. Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum tips. Must be at least 0.'
            example: null
        -
          in: query
          name: filter.duration
          description: 'Filter by minimum subscription duration (days). Must be at least 0.'
          example: null
          required: false
          schema:
            type: integer
            description: 'Filter by minimum subscription duration (days). Must be at least 0.'
            example: null
        -
          in: query
          name: query
          description: 'Search within fan name/username.'
          example: null
          required: false
          schema:
            type: string
            description: 'Search within fan name/username.'
            example: null
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                        header: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                        headerSize:
                          width: 4386
                          height: 1224
                        headerThumbs:
                          w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                          w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                        id: 123
                        name: name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: true
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: true
                        tipsEnabled: true
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 12.99
                        subscriptionBundles:
                          -
                            id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        displayName: ''
                        notice: ''
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong: false
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: null
                        subscribedOnExpiredNow: true
                        subscribedOnDuration: '7 days'
                        listsStates:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: true
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 12.99
                          subscribePrice: 12.99
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: 'Set to Expire'
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '2 months'
                          showPostsInFeed: true
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 360
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 12.99
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: '2025-01-01T00:00:00+00:00'
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '7 days'
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                          subscribes: []
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers: []
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999838
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49996
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                            header: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                            headerSize:
                              width: 4386
                              height: 1224
                            headerThumbs:
                              w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                              w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                            id: 123
                            name: name
                            username: username
                            canLookStory: true
                            canCommentStory: true
                            hasNotViewedStory: true
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: true
                            tipsEnabled: true
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 12.99
                            subscriptionBundles:
                              -
                                id: 123
                                discount: 50
                                duration: 3
                                price: 19.49
                                canBuy: true
                            displayName: ''
                            notice: ''
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong: false
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: null
                            subscribedOnExpiredNow: true
                            subscribedOnDuration: '7 days'
                            listsStates:
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              -
                                id: recent
                                type: recent
                                name: 'Recent (last 24 hours)'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: true
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: '2025-01-01T00:00:00+00:00'
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 12.99
                              subscribePrice: 12.99
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: 'Set to Expire'
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '2 months'
                              showPostsInFeed: true
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 360
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 12.99
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: '2025-01-01T00:00:00+00:00'
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '7 days'
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: '2025-01-01T00:00:00+00:00'
                              recommendations: 0
                              subscribes: []
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers: []
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                            header:
                              type: string
                              example: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4386
                                height:
                                  type: integer
                                  example: 1224
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                                w760:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: true
                            hasNotViewedStory:
                              type: boolean
                              example: true
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: true
                            tipsEnabled:
                              type: boolean
                              example: true
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 12.99
                            subscriptionBundles:
                              type: array
                              example:
                                -
                                  id: 123
                                  discount: 50
                                  duration: 3
                                  price: 19.49
                                  canBuy: true
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  discount:
                                    type: integer
                                    example: 50
                                  duration:
                                    type: integer
                                    example: 3
                                  price:
                                    type: number
                                    example: 19.49
                                  canBuy:
                                    type: boolean
                                    example: true
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: false
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: string
                              example: null
                            subscribedOnExpiredNow:
                              type: boolean
                              example: true
                            subscribedOnDuration:
                              type: string
                              example: '7 days'
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                -
                                  id: recent
                                  type: recent
                                  name: 'Recent (last 24 hours)'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: true
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                subscribePrice:
                                  type: number
                                  example: 12.99
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: 'Set to Expire'
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '2 months'
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 360
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 12.99
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: '2025-01-01T00:00:00+00:00'
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 360 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: number, example: 12.99 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: trial }
                                      offerStart: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '7 days'
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example: []
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example: []
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999838
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - Fans
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/fans/latest':
    get:
      summary: 'List Latest Fans'
      operationId: listLatestFans
      description: 'Get a paginated list fans, filterable by total, only new subscribers, or only renewals. Newest fans are first.'
      parameters:
        -
          in: query
          name: start_date
          description: 'Start date for filtering (required with end_date)'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Start date for filtering (required with end_date)'
            example: '2024-01-01'
            nullable: true
        -
          in: query
          name: end_date
          description: 'End date for filtering (required with start_date)'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'End date for filtering (required with start_date)'
            example: '2024-12-31'
            nullable: true
        -
          in: query
          name: type
          description: 'Filter by type: total, renew, or new'
          example: total
          required: false
          schema:
            type: string
            description: 'Filter by type: total, renew, or new'
            example: total
            nullable: true
        -
          in: query
          name: offset
          description: 'Number of fans to skip'
          example: 0
          required: false
          schema:
            type: string
            description: 'Number of fans to skip'
            example: 0
            nullable: true
        -
          in: query
          name: limit
          description: 'Number of fans to return (1-100)'
          example: 50
          required: false
          schema:
            type: string
            description: 'Number of fans to return (1-100)'
            example: 50
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    users:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 4.99
                        subscriptionBundles: []
                        displayName: ''
                        notice: ''
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '6 days'
                        listsStates:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        canReport: false
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: 'Set to Expire'
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '6 days'
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 7
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 4.99
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: '2025-01-01T00:00:00+00:00'
                              offerEnd: '2025-01-01T00:00:00+00:00'
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          -
                            id: 123
                            subscribeDays: 7
                            createdAt: '2025-01-01T00:00:00+00:00'
                            expiredAt: '2025-01-01T00:00:00+00:00'
                            finishedAt: '2025-01-01T00:00:00+00:00'
                            subscriberId: '123'
                            userId: '123'
                    offset: 0
                    hasMore: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999226
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49951
                properties:
                  data:
                    type: object
                    properties:
                      users:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 4.99
                            subscriptionBundles: []
                            displayName: ''
                            notice: ''
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '6 days'
                            listsStates:
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: recent
                                type: recent
                                name: 'Recent (last 24 hours)'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                            canReport: false
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: '2025-01-01T00:00:00+00:00'
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: 'Set to Expire'
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '6 days'
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: '2025-01-01T00:00:00+00:00'
                              recommendations: 0
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 7
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 4.99
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: '2025-01-01T00:00:00+00:00'
                                  offerEnd: '2025-01-01T00:00:00+00:00'
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              -
                                id: 123
                                subscribeDays: 7
                                createdAt: '2025-01-01T00:00:00+00:00'
                                expiredAt: '2025-01-01T00:00:00+00:00'
                                finishedAt: '2025-01-01T00:00:00+00:00'
                                subscriberId: '123'
                                userId: '123'
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                            header:
                              type: string
                              example: null
                            headerSize:
                              type: string
                              example: null
                            headerThumbs:
                              type: string
                              example: null
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 4.99
                            subscriptionBundles:
                              type: array
                              example: []
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                            subscribedByExpireDate:
                              type: string
                              example: null
                            subscribedByAutoprolong:
                              type: string
                              example: null
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                            currentSubscribePrice:
                              type: string
                              example: null
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: '6 days'
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: recent
                                  type: recent
                                  name: 'Recent (last 24 hours)'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: 'Set to Expire'
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '6 days'
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 7
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 4.99
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: '2025-01-01T00:00:00+00:00'
                                      offerEnd: '2025-01-01T00:00:00+00:00'
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 7 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: number, example: 4.99 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: trial }
                                      offerStart: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      offerEnd: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                -
                                  id: 123
                                  subscribeDays: 7
                                  createdAt: '2025-01-01T00:00:00+00:00'
                                  expiredAt: '2025-01-01T00:00:00+00:00'
                                  finishedAt: '2025-01-01T00:00:00+00:00'
                                  subscriberId: '123'
                                  userId: '123'
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 7
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  expiredAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  finishedAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  subscriberId:
                                    type: string
                                    example: '123'
                                  userId:
                                    type: string
                                    example: '123'
                      offset:
                        type: integer
                        example: 0
                      hasMore:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999226
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49951
      tags:
        - Fans
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                start_date:
                  type: string
                  description: 'This field is required when <code>end_date</code> is present.'
                  example: null
                  nullable: true
                end_date:
                  type: string
                  description: 'This field is required when <code>start_date</code> is present.'
                  example: null
                  nullable: true
                type:
                  type: string
                  description: ''
                  example: renew
                  enum:
                    - total
                    - renew
                    - new
                  nullable: true
                offset:
                  type: integer
                  description: 'Must be at least 0.'
                  example: 86
                limit:
                  type: integer
                  description: 'Must be at least 1. Must not be greater than 100.'
                  example: 12
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/fans/top':
    get:
      summary: 'List Top Fans'
      operationId: listTopFans
      description: 'Get a list of top fans sorted by spending. Filterable by total, subscriptions, tips, messages, posts, or streams.'
      parameters:
        -
          in: query
          name: start_date
          description: 'Start date for filtering (required with end_date). This field is required when <code>end_date</code> is present.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Start date for filtering (required with end_date). This field is required when <code>end_date</code> is present.'
            example: '2024-01-01'
            nullable: true
        -
          in: query
          name: end_date
          description: 'End date for filtering (required with start_date). This field is required when <code>start_date</code> is present.'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'End date for filtering (required with start_date). This field is required when <code>start_date</code> is present.'
            example: '2024-12-31'
            nullable: true
        -
          in: query
          name: by
          description: 'Sort by: total (default), subscribes, tips, messages, post, streams.'
          example: total
          required: false
          schema:
            type: string
            description: 'Sort by: total (default), subscribes, tips, messages, post, streams.'
            example: total
            enum:
              - total
              - subscribes
              - tips
              - messages
              - post
              - streams
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    users:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: true
                        subscribePrice: 4.99
                        subscriptionBundles: []
                        displayName: ''
                        notice: ''
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '6 days'
                        listsStates:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData: null
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: 'Set to Expire'
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '6 days'
                          tipsSumm: 500
                          subscribesSumm: 100
                          messagesSumm: 200
                          postsSumm: 50
                          streamsSumm: 25
                          totalSumm: 875
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                        canTrialSend: false
                        isBlocked: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999226
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49951
                properties:
                  data:
                    type: object
                    properties:
                      users:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: true
                            subscribePrice: 4.99
                            subscriptionBundles: []
                            displayName: ''
                            notice: ''
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '6 days'
                            listsStates:
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: '2025-01-01T00:00:00+00:00'
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData: null
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: 'Set to Expire'
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '6 days'
                              tipsSumm: 500
                              subscribesSumm: 100
                              messagesSumm: 200
                              postsSumm: 50
                              streamsSumm: 25
                              totalSumm: 875
                              lastActivity: '2025-01-01T00:00:00+00:00'
                              recommendations: 0
                            canTrialSend: false
                            isBlocked: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/l/la/lal/.../123/avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/l/la/lal/.../123/avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/l/la/lal/.../123/avatar.jpg'
                            header:
                              type: string
                              example: null
                            headerSize:
                              type: string
                              example: null
                            headerThumbs:
                              type: string
                              example: null
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: true
                            subscribePrice:
                              type: number
                              example: 4.99
                            subscriptionBundles:
                              type: array
                              example: []
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                            subscribedByExpireDate:
                              type: string
                              example: null
                            subscribedByAutoprolong:
                              type: string
                              example: null
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                            currentSubscribePrice:
                              type: string
                              example: null
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: '6 days'
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: false
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: SYSTEM_LIST
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: string
                              example: null
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: 'Set to Expire'
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '6 days'
                                tipsSumm:
                                  type: integer
                                  example: 500
                                subscribesSumm:
                                  type: integer
                                  example: 100
                                messagesSumm:
                                  type: integer
                                  example: 200
                                postsSumm:
                                  type: integer
                                  example: 50
                                streamsSumm:
                                  type: integer
                                  example: 25
                                totalSumm:
                                  type: integer
                                  example: 875
                                lastActivity:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                recommendations:
                                  type: integer
                                  example: 0
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999226
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49951
      tags:
        - Fans
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/fans/{fan_id}/custom-name':
    put:
      summary: "Set Fan's Custom Name"
      operationId: setFansCustomName
      description: "Change the Fan's Custom Name shown in OnlyFans"
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: x
                    avatar: 'https://public.onlyfans.com/files/q/...'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/q/...'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/q/...'
                    header: 'https://public.onlyfans.com/files/2/2j/2jy/...'
                    headerSize:
                      width: 792
                      height: 396
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/2/2j/2jy/...'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/2/2j/2jy/...'
                    id: 11223344
                    name: 'John Doe'
                    username: john-doe
                    canLookStory: false
                    canCommentStory: false
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: false
                    tipsTextEnabled: false
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 0
                    displayName: '🐳Whale ($100+)'
                    notice: ''
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: null
                    subscribedByExpire: null
                    subscribedByExpireDate: '2022-02-10T19:43:21+00:00'
                    subscribedByAutoprolong: null
                    subscribedIsExpiredNow: true
                    currentSubscribePrice: null
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: '12 days'
                    listsStates:
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: 859770744
                        type: bookmarks
                        name: Bookmarks
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: rebill_off
                        type: rebill_off
                        name: 'Renew Off'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: rebill_on
                        type: rebill_on
                        name: 'Renew On'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                    canReport: true
                    canReceiveChatMessage: false
                    hideChat: false
                    lastSeen: '2025-10-12T23:57:50+00:00'
                    isPerformer: true
                    isRealPerformer: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2021-11-12T19:43:21+00:00'
                      expiredAt: '2022-02-10T19:43:21+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '2 months'
                      showPostsInFeed: true
                      newPostsAfterExpireCount: 266
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 4.99
                      subscribePrice: 4.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-07-30T15:06:53+00:00'
                      expiredAt: '2025-08-11T18:04:17+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '12 days'
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canTrialSend: false
                    isBlocked: false
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 224616
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: x
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/q/...'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/q/...'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/q/...'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/2/2j/2jy/...'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 792
                          height:
                            type: integer
                            example: 396
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/2/2j/2jy/...'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/2/2j/2jy/...'
                      id:
                        type: integer
                        example: 11223344
                      name:
                        type: string
                        example: 'John Doe'
                      username:
                        type: string
                        example: john-doe
                      canLookStory:
                        type: boolean
                        example: false
                      canCommentStory:
                        type: boolean
                        example: false
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: false
                      tipsTextEnabled:
                        type: boolean
                        example: false
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: integer
                        example: 0
                      displayName:
                        type: string
                        example: '🐳Whale ($100+)'
                      notice:
                        type: string
                        example: ''
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: string
                        example: null
                      subscribedByExpire:
                        type: string
                        example: null
                      subscribedByExpireDate:
                        type: string
                        example: '2022-02-10T19:43:21+00:00'
                      subscribedByAutoprolong:
                        type: string
                        example: null
                      subscribedIsExpiredNow:
                        type: boolean
                        example: true
                      currentSubscribePrice:
                        type: string
                        example: null
                      subscribedOn:
                        type: string
                        example: null
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: '12 days'
                      listsStates:
                        type: array
                        example:
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: 859770744
                            type: bookmarks
                            name: Bookmarks
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: rebill_off
                            type: rebill_off
                            name: 'Renew Off'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: rebill_on
                            type: rebill_on
                            name: 'Renew On'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: recent
                            type:
                              type: string
                              example: recent
                            name:
                              type: string
                              example: 'Recent (last 24 hours)'
                            hasUser:
                              type: boolean
                              example: false
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: SYSTEM_LIST
                      canReport:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: false
                      hideChat:
                        type: boolean
                        example: false
                      lastSeen:
                        type: string
                        example: '2025-10-12T23:57:50+00:00'
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2021-11-12T19:43:21+00:00'
                          expiredAt:
                            type: string
                            example: '2022-02-10T19:43:21+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '2 months'
                          showPostsInFeed:
                            type: boolean
                            example: true
                          newPostsAfterExpireCount:
                            type: integer
                            example: 266
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 4.99
                          subscribePrice:
                            type: number
                            example: 4.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-07-30T15:06:53+00:00'
                          expiredAt:
                            type: string
                            example: '2025-08-11T18:04:17+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '12 days'
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224616
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Fans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_name:
                  type: string
                  description: 'New Custom Name for a Fan. Send empty string (`""`) or `null` to clear out the custom name.'
                  example: '🐳Whale ($100+)'
              required:
                - custom_name
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: fan_id
        description: "Fan's OnlyFans ID"
        example: 11223344
        required: true
        schema:
          type: string
  '/api/{account}/fans/{fan_id}/notes':
    get:
      summary: 'Get Fan Notes'
      operationId: getFanNotes
      description: 'Retrieve notes for a specific fan.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    notes: 'Example note'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999897
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49985
                properties:
                  data:
                    type: object
                    properties:
                      notes:
                        type: string
                        example: 'Example note'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999897
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49985
      tags:
        - Fans
    put:
      summary: 'Create/Edit Fan Notes'
      operationId: createEditFanNotes
      description: 'Create or edit notes for a specific fan.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: x
                    avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../.../avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../.../avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../.../avatar.jpg'
                    header: 'https://public.onlyfans.com/files/c/cs/cse/.../.../header_image.jpg'
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../.../header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../.../header_image.jpg'
                    id: 123
                    name: Name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      -
                        id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ''
                    notice: foo
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: '2022-01-01T00:00:00+00:00'
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: '7 days'
                    listsStates:
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    canReport: true
                    canReceiveChatMessage: true
                    hideChat: false
                    lastSeen: '2022-01-01T00:00:00+00:00'
                    isPerformer: true
                    isRealPerformer: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2022-01-01T00:00:00+00:00'
                      expiredAt: '2022-01-01T00:00:00+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: 'Set to Expire'
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '5 months'
                      showPostsInFeed: true
                      subscribes:
                        -
                          id: 123
                          userId: 123
                          subscriberId: 123
                          date: '2022-01-01T00:00:00+00:00'
                          duration: 123
                          startDate: '2022-01-01T00:00:00+00:00'
                          expireDate: '2022-01-01T00:00:00+00:00'
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: '2022-01-01T00:00:00+00:00'
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2022-01-01T00:00:00+00:00'
                      expiredAt: '2022-01-01T00:00:00+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '7 days'
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canTrialSend: false
                    isBlocked: false
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999904
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: x
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/i/i2/i25/.../.../avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../.../avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../.../avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/c/cs/cse/.../.../header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../.../header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../.../header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: Name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          -
                            id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ''
                      notice:
                        type: string
                        example: foo
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: '2022-01-01T00:00:00+00:00'
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: '7 days'
                      listsStates:
                        type: array
                        example:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      canReport:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      hideChat:
                        type: boolean
                        example: false
                      lastSeen:
                        type: string
                        example: '2022-01-01T00:00:00+00:00'
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          expiredAt:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: 'Set to Expire'
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '5 months'
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              -
                                id: 123
                                userId: 123
                                subscriberId: 123
                                date: '2022-01-01T00:00:00+00:00'
                                duration: 123
                                startDate: '2022-01-01T00:00:00+00:00'
                                expireDate: '2022-01-01T00:00:00+00:00'
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: '2022-01-01T00:00:00+00:00'
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: '2022-01-01T00:00:00+00:00'
                                duration:
                                  type: integer
                                  example: 123
                                startDate:
                                  type: string
                                  example: '2022-01-01T00:00:00+00:00'
                                expireDate:
                                  type: string
                                  example: '2022-01-01T00:00:00+00:00'
                                cancelDate:
                                  type: string
                                  example: null
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: '2022-01-01T00:00:00+00:00'
                                offerEnd:
                                  type: string
                                  example: null
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          expiredAt:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '7 days'
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999904
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Fans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notes:
                  type: string
                  description: 'The new note value.'
                  example: 'Example note'
              required:
                - notes
    delete:
      summary: 'Clear Fan Notes'
      operationId: clearFanNotes
      description: 'Clear notes for a specific fan.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: x
                    avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../.../avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../.../avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../.../avatar.jpg'
                    header: 'https://public.onlyfans.com/files/c/cs/cse/.../.../header_image.jpg'
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../.../header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../.../header_image.jpg'
                    id: 123
                    name: Name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      -
                        id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ''
                    notice: foo
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: '2022-01-01T00:00:00+00:00'
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: '7 days'
                    listsStates:
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    canReport: true
                    canReceiveChatMessage: true
                    hideChat: false
                    lastSeen: '2022-01-01T00:00:00+00:00'
                    isPerformer: true
                    isRealPerformer: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2022-01-01T00:00:00+00:00'
                      expiredAt: '2022-01-01T00:00:00+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: 'Set to Expire'
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '5 months'
                      showPostsInFeed: true
                      subscribes:
                        -
                          id: 123
                          userId: 123
                          subscriberId: 123
                          date: '2022-01-01T00:00:00+00:00'
                          duration: 123
                          startDate: '2022-01-01T00:00:00+00:00'
                          expireDate: '2022-01-01T00:00:00+00:00'
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: '2022-01-01T00:00:00+00:00'
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2022-01-01T00:00:00+00:00'
                      expiredAt: '2022-01-01T00:00:00+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '7 days'
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canTrialSend: false
                    isBlocked: false
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999904
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: x
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/i/i2/i25/.../.../avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../.../avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../.../avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/c/cs/cse/.../.../header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../.../header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../.../header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: Name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          -
                            id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ''
                      notice:
                        type: string
                        example: foo
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: '2022-01-01T00:00:00+00:00'
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: '7 days'
                      listsStates:
                        type: array
                        example:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      canReport:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      hideChat:
                        type: boolean
                        example: false
                      lastSeen:
                        type: string
                        example: '2022-01-01T00:00:00+00:00'
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          expiredAt:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: 'Set to Expire'
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '5 months'
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              -
                                id: 123
                                userId: 123
                                subscriberId: 123
                                date: '2022-01-01T00:00:00+00:00'
                                duration: 123
                                startDate: '2022-01-01T00:00:00+00:00'
                                expireDate: '2022-01-01T00:00:00+00:00'
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: '2022-01-01T00:00:00+00:00'
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: '2022-01-01T00:00:00+00:00'
                                duration:
                                  type: integer
                                  example: 123
                                startDate:
                                  type: string
                                  example: '2022-01-01T00:00:00+00:00'
                                expireDate:
                                  type: string
                                  example: '2022-01-01T00:00:00+00:00'
                                cancelDate:
                                  type: string
                                  example: null
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: '2022-01-01T00:00:00+00:00'
                                offerEnd:
                                  type: string
                                  example: null
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          expiredAt:
                            type: string
                            example: '2022-01-01T00:00:00+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '7 days'
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999904
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Fans
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: fan_id
        description: "Fan's OnlyFans ID"
        example: 123
        required: true
        schema:
          type: string
  '/api/{account}/fans/{user_id}/subscriptions-history':
    get:
      summary: 'Get Subscription History'
      operationId: getSubscriptionHistory
      description: "Get Subscription History for a given OnlyFans User ID. This can be useful, for example, when the user's subscribed to your account for the first time."
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        subscribeDate: '2022-06-18T19:39:16+00:00'
                        expireDate: '2022-07-18T19:39:16+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2022-08-15T02:59:40+00:00'
                        expireDate: '2022-09-15T02:59:40+00:00'
                        price: 11.04
                      -
                        subscribeDate: '2022-09-25T15:21:27+00:00'
                        expireDate: '2022-10-25T15:21:27+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2023-01-07T15:53:09+00:00'
                        expireDate: '2023-02-07T15:53:09+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2023-03-03T16:10:44+00:00'
                        expireDate: '2023-04-03T16:10:44+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2023-05-07T19:38:24+00:00'
                        expireDate: '2023-06-07T19:38:24+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2023-10-16T15:43:16+00:00'
                        expireDate: '2023-11-16T15:43:16+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2024-01-27T11:52:03+00:00'
                        expireDate: '2024-02-27T11:52:03+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2024-06-30T15:27:07+00:00'
                        expireDate: '2024-07-30T15:27:07+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2024-09-27T03:20:34+00:00'
                        expireDate: '2024-10-27T03:20:34+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2024-12-18T19:57:33+00:00'
                        expireDate: '2025-01-18T19:57:33+00:00'
                        price: 3.25
                      -
                        subscribeDate: '2025-05-13T02:26:27+00:00'
                        expireDate: '2025-06-13T02:26:27+00:00'
                        price: 3.25
                      -
                        subscribeDate: '2025-06-20T02:35:27+00:00'
                        expireDate: '2025-07-20T02:35:27+00:00'
                        price: 12.99
                      -
                        subscribeDate: '2025-08-04T14:56:23+00:00'
                        expireDate: '2025-09-04T14:56:23+00:00'
                        price: 3.25
                      -
                        subscribeDate: '2025-10-11T05:45:51+00:00'
                        expireDate: '2025-10-18T05:45:51+00:00'
                        price: 0
                      -
                        subscribeDate: '2025-11-07T21:55:21+00:00'
                        expireDate: '2025-12-07T21:55:21+00:00'
                        price: 12.99
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 224348
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            subscribeDate: '2022-06-18T19:39:16+00:00'
                            expireDate: '2022-07-18T19:39:16+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2022-08-15T02:59:40+00:00'
                            expireDate: '2022-09-15T02:59:40+00:00'
                            price: 11.04
                          -
                            subscribeDate: '2022-09-25T15:21:27+00:00'
                            expireDate: '2022-10-25T15:21:27+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2023-01-07T15:53:09+00:00'
                            expireDate: '2023-02-07T15:53:09+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2023-03-03T16:10:44+00:00'
                            expireDate: '2023-04-03T16:10:44+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2023-05-07T19:38:24+00:00'
                            expireDate: '2023-06-07T19:38:24+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2023-10-16T15:43:16+00:00'
                            expireDate: '2023-11-16T15:43:16+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2024-01-27T11:52:03+00:00'
                            expireDate: '2024-02-27T11:52:03+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2024-06-30T15:27:07+00:00'
                            expireDate: '2024-07-30T15:27:07+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2024-09-27T03:20:34+00:00'
                            expireDate: '2024-10-27T03:20:34+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2024-12-18T19:57:33+00:00'
                            expireDate: '2025-01-18T19:57:33+00:00'
                            price: 3.25
                          -
                            subscribeDate: '2025-05-13T02:26:27+00:00'
                            expireDate: '2025-06-13T02:26:27+00:00'
                            price: 3.25
                          -
                            subscribeDate: '2025-06-20T02:35:27+00:00'
                            expireDate: '2025-07-20T02:35:27+00:00'
                            price: 12.99
                          -
                            subscribeDate: '2025-08-04T14:56:23+00:00'
                            expireDate: '2025-09-04T14:56:23+00:00'
                            price: 3.25
                          -
                            subscribeDate: '2025-10-11T05:45:51+00:00'
                            expireDate: '2025-10-18T05:45:51+00:00'
                            price: 0
                          -
                            subscribeDate: '2025-11-07T21:55:21+00:00'
                            expireDate: '2025-12-07T21:55:21+00:00'
                            price: 12.99
                        items:
                          type: object
                          properties:
                            subscribeDate:
                              type: string
                              example: '2022-06-18T19:39:16+00:00'
                            expireDate:
                              type: string
                              example: '2022-07-18T19:39:16+00:00'
                            price:
                              type: number
                              example: 12.99
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224348
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Fans
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: user_id
        description: 'The OnlyFans ID of the User.'
        example: 123
        required: true
        schema:
          type: string
  '/api/{account}/following/all':
    get:
      summary: 'List All Followings'
      operationId: listAllFollowings
      description: 'Get a paginated list of followings for an Account. Newest followings are first.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of followings to return (1-50). Must be at least 1. Must not be greater than 50.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of followings to return (1-50). Must be at least 1. Must not be greater than 50.'
            example: 10
        -
          in: query
          name: offset
          description: 'Pagination offset. Must be at least 0.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Pagination offset. Must be at least 0.'
            example: 0
        -
          in: query
          name: query
          description: 'Search within following name/username.'
          example: john
          required: false
          schema:
            type: string
            description: 'Search within following name/username.'
            example: john
            nullable: true
        -
          in: query
          name: filter
          description: ''
          example: []
          required: false
          schema:
            type: object
            description: ''
            example: []
            properties: {  }
        -
          in: query
          name: filter.online
          description: 'Filter by online status (1 for online, 0 for offline, null for all).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by online status (1 for online, 0 for offline, null for all).'
            example: 1
            enum:
              - '1'
              - '0'
            nullable: true
        -
          in: query
          name: filter.paid
          description: 'Filter by paid status (1 for paid, 0 for free, null for all).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by paid status (1 for paid, 0 for free, null for all).'
            example: 1
            enum:
              - '1'
              - '0'
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                        header: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                        headerSize:
                          width: 4868
                          height: 851
                        headerThumbs:
                          w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                          w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                        id: 254
                        name: 'OnlyFans Creators'
                        username: onlyfanscreators
                        canLookStory: true
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: true
                        tipsTextEnabled: false
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: false
                        subscribePrice: 0
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: false
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        listsStates:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: false
                        hideChat: false
                        lastSeen: null
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: '2025-01-01T00:00:00+00:00'
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '4 months'
                          showPostsInFeed: true
                          subscribes:
                            -
                              id: 123
                              userId: 254
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 3652
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData: null
                        canTrialSend: false
                        isBlocked: false
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_abc123/following/all?offset=10&limit=10'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999988
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49942
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            header: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            headerSize:
                              width: 4868
                              height: 851
                            headerThumbs:
                              w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                              w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            id: 254
                            name: 'OnlyFans Creators'
                            username: onlyfanscreators
                            canLookStory: true
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: true
                            tipsTextEnabled: false
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: false
                            subscribePrice: 0
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: false
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            listsStates:
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: false
                            hideChat: false
                            lastSeen: null
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: '2025-01-01T00:00:00+00:00'
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '4 months'
                              showPostsInFeed: true
                              subscribes:
                                -
                                  id: 123
                                  userId: 254
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 3652
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData: null
                            canTrialSend: false
                            isBlocked: false
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            header:
                              type: string
                              example: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4868
                                height:
                                  type: integer
                                  example: 851
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                                w760:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            id:
                              type: integer
                              example: 254
                            name:
                              type: string
                              example: 'OnlyFans Creators'
                            username:
                              type: string
                              example: onlyfanscreators
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: true
                            tipsTextEnabled:
                              type: boolean
                              example: false
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: false
                            subscribedOnExpiredNow:
                              type: string
                              example: null
                            subscribedOnDuration:
                              type: string
                              example: null
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: false
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: null
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '4 months'
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 254
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 3652
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 254 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 3652 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 0 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: auto }
                                      offerStart: { type: string, example: null }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: string
                              example: null
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_abc123/following/all?offset=10&limit=10'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999988
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49942
      tags:
        - Following
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/following/active':
    get:
      summary: 'List Active Followings'
      operationId: listActiveFollowings
      description: 'Get a paginated list of followings for an Account. Newest followings are first.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of followings to return (1-50). Must be at least 1. Must not be greater than 50.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of followings to return (1-50). Must be at least 1. Must not be greater than 50.'
            example: 10
        -
          in: query
          name: offset
          description: 'Pagination offset. Must be at least 0.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Pagination offset. Must be at least 0.'
            example: 0
        -
          in: query
          name: query
          description: 'Search within following name/username.'
          example: john
          required: false
          schema:
            type: string
            description: 'Search within following name/username.'
            example: john
            nullable: true
        -
          in: query
          name: filter
          description: ''
          example: []
          required: false
          schema:
            type: object
            description: ''
            example: []
            properties: {  }
        -
          in: query
          name: filter.online
          description: 'Filter by online status (1 for online, 0 for offline, null for all).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by online status (1 for online, 0 for offline, null for all).'
            example: 1
            enum:
              - '1'
              - '0'
            nullable: true
        -
          in: query
          name: filter.paid
          description: 'Filter by paid status (1 for paid, 0 for free, null for all).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by paid status (1 for paid, 0 for free, null for all).'
            example: 1
            enum:
              - '1'
              - '0'
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                        header: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                        headerSize:
                          width: 4868
                          height: 851
                        headerThumbs:
                          w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                          w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                        id: 254
                        name: 'OnlyFans Creators'
                        username: onlyfanscreators
                        canLookStory: true
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: true
                        tipsTextEnabled: false
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: false
                        subscribePrice: 0
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: false
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        listsStates:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: false
                        hideChat: false
                        lastSeen: null
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: '2025-01-01T00:00:00+00:00'
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '4 months'
                          showPostsInFeed: true
                          subscribes:
                            -
                              id: 123
                              userId: 254
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 3652
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData: null
                        canTrialSend: false
                        isBlocked: false
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_abc123/following/active?offset=10&limit=10'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999971
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            header: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            headerSize:
                              width: 4868
                              height: 851
                            headerThumbs:
                              w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                              w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            id: 254
                            name: 'OnlyFans Creators'
                            username: onlyfanscreators
                            canLookStory: true
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: true
                            tipsTextEnabled: false
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: false
                            subscribePrice: 0
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: false
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            listsStates:
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: false
                            hideChat: false
                            lastSeen: null
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: '2025-01-01T00:00:00+00:00'
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '4 months'
                              showPostsInFeed: true
                              subscribes:
                                -
                                  id: 123
                                  userId: 254
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 3652
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData: null
                            canTrialSend: false
                            isBlocked: false
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            header:
                              type: string
                              example: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4868
                                height:
                                  type: integer
                                  example: 851
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                                w760:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            id:
                              type: integer
                              example: 254
                            name:
                              type: string
                              example: 'OnlyFans Creators'
                            username:
                              type: string
                              example: onlyfanscreators
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: true
                            tipsTextEnabled:
                              type: boolean
                              example: false
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: false
                            subscribedOnExpiredNow:
                              type: string
                              example: null
                            subscribedOnDuration:
                              type: string
                              example: null
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: false
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: null
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '4 months'
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 254
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 3652
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 254 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 3652 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 0 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: auto }
                                      offerStart: { type: string, example: null }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: string
                              example: null
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_abc123/following/active?offset=10&limit=10'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999971
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Following
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/following/expired':
    get:
      summary: 'List Expired Followings'
      operationId: listExpiredFollowings
      description: 'Get a paginated list of expired followings for an Account. Newest followings are first.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of followings to return (1-50). Must be at least 1. Must not be greater than 50.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of followings to return (1-50). Must be at least 1. Must not be greater than 50.'
            example: 10
        -
          in: query
          name: offset
          description: 'Pagination offset. Must be at least 0.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Pagination offset. Must be at least 0.'
            example: 0
        -
          in: query
          name: query
          description: 'Search within following name/username.'
          example: john
          required: false
          schema:
            type: string
            description: 'Search within following name/username.'
            example: john
            nullable: true
        -
          in: query
          name: filter
          description: ''
          example: []
          required: false
          schema:
            type: object
            description: ''
            example: []
            properties: {  }
        -
          in: query
          name: filter.online
          description: 'Filter by online status (1 for online, 0 for offline, null for all).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by online status (1 for online, 0 for offline, null for all).'
            example: 1
            enum:
              - '1'
              - '0'
            nullable: true
        -
          in: query
          name: filter.paid
          description: 'Filter by paid status (1 for paid, 0 for free, null for all).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by paid status (1 for paid, 0 for free, null for all).'
            example: 1
            enum:
              - '1'
              - '0'
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                        header: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                        headerSize:
                          width: 4868
                          height: 851
                        headerThumbs:
                          w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                          w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                        id: 254
                        name: 'OnlyFans Creators'
                        username: onlyfanscreators
                        canLookStory: true
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: true
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: true
                        tipsTextEnabled: false
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: true
                        canAddSubscriber: false
                        subscribePrice: 0
                        isPaywallRequired: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: false
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        listsStates:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                        canReport: false
                        canReceiveChatMessage: false
                        hideChat: false
                        lastSeen: null
                        isPerformer: true
                        isRealPerformer: true
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: '2025-01-01T00:00:00+00:00'
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '4 months'
                          showPostsInFeed: true
                          subscribes:
                            -
                              id: 123
                              userId: 254
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 3652
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData: null
                        canTrialSend: false
                        isBlocked: false
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_abc123/following/expired?offset=10&limit=10'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999970
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49993
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            header: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            headerSize:
                              width: 4868
                              height: 851
                            headerThumbs:
                              w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                              w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            id: 254
                            name: 'OnlyFans Creators'
                            username: onlyfanscreators
                            canLookStory: true
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: true
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: true
                            tipsTextEnabled: false
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: true
                            canAddSubscriber: false
                            subscribePrice: 0
                            isPaywallRequired: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: false
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            listsStates:
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                            canReport: false
                            canReceiveChatMessage: false
                            hideChat: false
                            lastSeen: null
                            isPerformer: true
                            isRealPerformer: true
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: '2025-01-01T00:00:00+00:00'
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '4 months'
                              showPostsInFeed: true
                              subscribes:
                                -
                                  id: 123
                                  userId: 254
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 3652
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData: null
                            canTrialSend: false
                            isBlocked: false
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            header:
                              type: string
                              example: 'https://public.onlyfans.com/files/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 4868
                                height:
                                  type: integer
                                  example: 851
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                                w760:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/x/xl/xlu/xlusgobxpcebctdptohj7bogxvl9flfu1671047829/254/header.jpg'
                            id:
                              type: integer
                              example: 254
                            name:
                              type: string
                              example: 'OnlyFans Creators'
                            username:
                              type: string
                              example: onlyfanscreators
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: true
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: true
                            tipsTextEnabled:
                              type: boolean
                              example: false
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: true
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isPaywallRequired:
                              type: boolean
                              example: true
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: false
                            subscribedOnExpiredNow:
                              type: string
                              example: null
                            subscribedOnDuration:
                              type: string
                              example: null
                            listsStates:
                              type: array
                              example:
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: following
                                  type:
                                    type: string
                                    example: following
                                  name:
                                    type: string
                                    example: Following
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: false
                            canReceiveChatMessage:
                              type: boolean
                              example: false
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: null
                            isPerformer:
                              type: boolean
                              example: true
                            isRealPerformer:
                              type: boolean
                              example: true
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '4 months'
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 254
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 3652
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 254 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 3652 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 0 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: auto }
                                      offerStart: { type: string, example: null }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: string
                              example: null
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_abc123/following/expired?offset=10&limit=10'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999970
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49993
      tags:
        - Following
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/trial-links':
    get:
      summary: 'List Free Trial Links'
      operationId: listFreeTrialLinks
      description: 'List all free trial links for the account, including the details and statistics'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of trial links to return. Default `10`'
          example: 10
          required: true
          schema:
            type: integer
            description: 'The number of trial links to return. Default `10`'
            example: 10
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: true
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
        -
          in: query
          name: sort
          description: 'Sort the results. Default `desc`'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort the results. Default `desc`'
            example: desc
            enum:
              - desc
              - asc
            nullable: true
        -
          in: query
          name: field
          description: 'Sort the results by a field. Default `create_date`'
          example: create_date
          required: false
          schema:
            type: string
            description: 'Sort the results by a field. Default `create_date`'
            example: create_date
            enum:
              - create_date
              - expire_date
              - subscribe_counts
              - subscribe_days
              - claims_count
            nullable: true
        -
          in: query
          name: synchronous
          description: 'Wait for the revenue data to finish processing, instead of processing in the background. **Will result in longer response times, use with caution**. Default `false`'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Wait for the revenue data to finish processing, instead of processing in the background. **Will result in longer response times, use with caution**. Default `false`'
            example: false
            nullable: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        trialLinkName: 'Trial link name'
                        url: 'https://onlyfans.com/username/trial/abc123'
                        subscribeDays: 30
                        subscribeCounts: 0
                        claimCounts: 123
                        clicksCounts: 182
                        expiredAt: null
                        createdAt: '2025-01-01T01:01:01+00:00'
                        isFinished: false
                        tags:
                          - Instagram
                          - Twitter
                        revenue:
                          total: 123.0
                          revenuePerSubscriber: 12.0
                          spendersCount: 16
                          calculatedAt: '2025-01-01T01:01:01+00:00'
                          isLoading: false
                        links:
                          related:
                            subscribers: 'https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers'
                    hasMore: true
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_abc123/trial-links?limit=10&offset=10'
                  _meta:
                    _credits:
                      used: 1
                      balance: 115580
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            trialLinkName: 'Trial link name'
                            url: 'https://onlyfans.com/username/trial/abc123'
                            subscribeDays: 30
                            subscribeCounts: 0
                            claimCounts: 123
                            clicksCounts: 182
                            expiredAt: null
                            createdAt: '2025-01-01T01:01:01+00:00'
                            isFinished: false
                            tags:
                              - Instagram
                              - Twitter
                            revenue:
                              total: 123
                              revenuePerSubscriber: 12
                              spendersCount: 16
                              calculatedAt: '2025-01-01T01:01:01+00:00'
                              isLoading: false
                            links:
                              related:
                                subscribers: 'https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers'
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            trialLinkName:
                              type: string
                              example: 'Trial link name'
                            url:
                              type: string
                              example: 'https://onlyfans.com/username/trial/abc123'
                            subscribeDays:
                              type: integer
                              example: 30
                            subscribeCounts:
                              type: integer
                              example: 0
                            claimCounts:
                              type: integer
                              example: 123
                            clicksCounts:
                              type: integer
                              example: 182
                            expiredAt:
                              type: string
                              example: null
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            isFinished:
                              type: boolean
                              example: false
                            tags:
                              type: array
                              example:
                                - Instagram
                                - Twitter
                              items:
                                type: string
                            revenue:
                              type: object
                              properties:
                                total:
                                  type: number
                                  example: 123.0
                                revenuePerSubscriber:
                                  type: number
                                  example: 12.0
                                spendersCount:
                                  type: integer
                                  example: 16
                                calculatedAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                isLoading:
                                  type: boolean
                                  example: false
                            links:
                              type: object
                              properties:
                                related:
                                  type: object
                                  properties:
                                    subscribers:
                                      type: string
                                      example: 'https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers'
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_abc123/trial-links?limit=10&offset=10'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 115580
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - 'Free Trial Links'
    post:
      summary: 'Create Free Trial Link'
      operationId: createFreeTrialLink
      description: 'Create a new free trial link for the account'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    trialLinkName: 'My new trial link'
                    url: 'https://onlyfans.com/username/trial/code'
                    subscribeDays: 123
                    subscribeCounts: 123
                    claimCounts: 123
                    expiredAt: '2025-01-05T00:00:00+00:00'
                    createdAt: '2025-01-01T00:00:00+00:00'
                    isFinished: false
                  _pagination:
                    next_page: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999840
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49993
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      trialLinkName:
                        type: string
                        example: 'My new trial link'
                      url:
                        type: string
                        example: 'https://onlyfans.com/username/trial/code'
                      subscribeDays:
                        type: integer
                        example: 123
                      subscribeCounts:
                        type: integer
                        example: 123
                      claimCounts:
                        type: integer
                        example: 123
                      expiredAt:
                        type: string
                        example: '2025-01-05T00:00:00+00:00'
                      createdAt:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      isFinished:
                        type: boolean
                        example: false
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999840
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49993
      tags:
        - 'Free Trial Links'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: 'Array of tag names to add to the trial link.'
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
                name:
                  type: string
                  description: 'The name of the trail link (optional). Cannot be longer than 64 characters.'
                  example: 7
                  nullable: true
                offerExpiration:
                  type: integer
                  description: 'The trial link expiration **in days (from now)**. Must either be **0** (to never expire), or a number between **1** and **30**.'
                  example: 7
                offerLimit:
                  type: integer
                  description: 'How many people can use this offer. Must either be **0** (for no limit), or a number between **1**-**10**, **50**, or **100**.'
                  example: 7
                  enum:
                    - 0
                    - 1
                    - 2
                    - 3
                    - 4
                    - 5
                    - 6
                    - 7
                    - 8
                    - 9
                    - 10
                    - 50
                    - 100
                duration:
                  type: integer
                  description: 'The duration of the free trial **in days**. Must be **1**, **3**, **7**, **14**, **30** (1 month), **90** (3 months), **180** (6 months), or **360** (12 months).'
                  example: 7
                  enum:
                    - 1
                    - 3
                    - 7
                    - 14
                    - 30
                    - 90
                    - 180
                    - 360
              required:
                - offerExpiration
                - offerLimit
                - duration
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/trial-links/{trial_link_id}':
    get:
      summary: 'Get Free Trial Link'
      operationId: getFreeTrialLink
      description: "Get individual Free Trial Link details and it's revenue data"
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    trialLinkName: 'Trial link name'
                    url: 'https://onlyfans.com/username/trial/abc123'
                    subscribeDays: 30
                    subscribeCounts: 0
                    claimCounts: 123
                    clicksCounts: 182
                    expiredAt: null
                    createdAt: '2025-01-01T01:01:01+00:00'
                    isFinished: false
                    tags:
                      - Instagram
                      - Twitter
                    revenue:
                      total: 123.0
                      revenuePerSubscriber: 12.0
                      spendersCount: 16
                      calculatedAt: '2025-01-01T01:01:01+00:00'
                      isLoading: false
                    links:
                      related:
                        subscribers: 'https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers'
                  _meta:
                    _credits:
                      used: 1
                      balance: 7095551
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      trialLinkName:
                        type: string
                        example: 'Trial link name'
                      url:
                        type: string
                        example: 'https://onlyfans.com/username/trial/abc123'
                      subscribeDays:
                        type: integer
                        example: 30
                      subscribeCounts:
                        type: integer
                        example: 0
                      claimCounts:
                        type: integer
                        example: 123
                      clicksCounts:
                        type: integer
                        example: 182
                      expiredAt:
                        type: string
                        example: null
                      createdAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isFinished:
                        type: boolean
                        example: false
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                        items:
                          type: string
                      revenue:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 123.0
                          revenuePerSubscriber:
                            type: number
                            example: 12.0
                          spendersCount:
                            type: integer
                            example: 16
                          calculatedAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          isLoading:
                            type: boolean
                            example: false
                      links:
                        type: object
                        properties:
                          related:
                            type: object
                            properties:
                              subscribers:
                                type: string
                                example: 'https://app.onlyfansapi.com/api/acct_abc123/trial-links/123/subscribers'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 7095551
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Free Trial Links'
    delete:
      summary: 'Delete Free Trial Link'
      operationId: deleteFreeTrialLink
      description: 'Delete a free trial link by its ID'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999837
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999837
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - 'Free Trial Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: trial_link_id
        description: 'The ID of the trial link.'
        example: est
        required: true
        schema:
          type: string
  '/api/{account}/trial-links/{trial_link_id}/subscribers':
    get:
      summary: 'List Free Trial Link Subscribers'
      operationId: listFreeTrialLinkSubscribers
      description: 'Get list of subscribers who joined through a Free Trial Link'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of subscribers to return per page. Default `10`'
          example: 10
          required: true
          schema:
            type: integer
            description: 'The number of subscribers to return per page. Default `10`'
            example: 10
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: true
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                        header: 'https://public.onlyfans.com/files/.../header.jpg'
                        headerSize:
                          width: 2160
                          height: 2700
                        headerThumbs:
                          w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                          w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                        id: 123
                        name: name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '3 days'
                        listsStates:
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: USER_NOT_PERFORMER
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: rebill_off
                            type: rebill_off
                            name: 'Renew Off'
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: rebill_on
                            type: rebill_on
                            name: 'Renew On'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        canReport: true
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: false
                        isRealPerformer: false
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: '2025-01-01T00:00:00+00:00'
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '3 days'
                          showPostsInFeed: true
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 123
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 5
                          subscribePrice: 5
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: 'Set to Expire'
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '3 days'
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 90
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 5
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: '2025-01-01T00:00:00+00:00'
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          -
                            id: 123
                            subscribeDays: 90
                            createdAt: '2025-01-01T00:00:00+00:00'
                            expiredAt: null
                            finishedAt: '2025-01-01T00:00:00+00:00'
                            subscriberId: '123'
                            userId: '123'
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    hasMore: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000028
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                            header: 'https://public.onlyfans.com/files/.../header.jpg'
                            headerSize:
                              width: 2160
                              height: 2700
                            headerThumbs:
                              w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                              w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                            id: 123
                            name: name
                            username: username
                            canLookStory: true
                            canCommentStory: true
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '3 days'
                            listsStates:
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: USER_NOT_PERFORMER
                              -
                                id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: recent
                                type: recent
                                name: 'Recent (last 24 hours)'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: rebill_off
                                type: rebill_off
                                name: 'Renew Off'
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: rebill_on
                                type: rebill_on
                                name: 'Renew On'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              -
                                id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                            canReport: true
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: '2025-01-01T00:00:00+00:00'
                            isPerformer: false
                            isRealPerformer: false
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: '2025-01-01T00:00:00+00:00'
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '3 days'
                              showPostsInFeed: true
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 123
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 5
                              subscribePrice: 5
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: 'Set to Expire'
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '3 days'
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: '2025-01-01T00:00:00+00:00'
                              recommendations: 0
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 90
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 5
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: '2025-01-01T00:00:00+00:00'
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              -
                                id: 123
                                subscribeDays: 90
                                createdAt: '2025-01-01T00:00:00+00:00'
                                expiredAt: null
                                finishedAt: '2025-01-01T00:00:00+00:00'
                                subscriberId: '123'
                                userId: '123'
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/.../avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                            header:
                              type: string
                              example: 'https://public.onlyfans.com/files/.../header.jpg'
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 2160
                                height:
                                  type: integer
                                  example: 2700
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                                w760:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: true
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: '3 days'
                            listsStates:
                              type: array
                              example:
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: USER_NOT_PERFORMER
                                -
                                  id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: recent
                                  type: recent
                                  name: 'Recent (last 24 hours)'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: rebill_off
                                  type: rebill_off
                                  name: 'Renew Off'
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: rebill_on
                                  type: rebill_on
                                  name: 'Renew On'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                -
                                  id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: fans
                                  type:
                                    type: string
                                    example: fans
                                  name:
                                    type: string
                                    example: Fans
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: true
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPerformer:
                              type: boolean
                              example: false
                            isRealPerformer:
                              type: boolean
                              example: false
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '3 days'
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 123
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 123 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 0 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: auto }
                                      offerStart: { type: string, example: null }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 5
                                subscribePrice:
                                  type: integer
                                  example: 5
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: 'Set to Expire'
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '3 days'
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 90
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 5
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: '2025-01-01T00:00:00+00:00'
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 90 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 5 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: trial }
                                      offerStart: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                -
                                  id: 123
                                  subscribeDays: 90
                                  createdAt: '2025-01-01T00:00:00+00:00'
                                  expiredAt: null
                                  finishedAt: '2025-01-01T00:00:00+00:00'
                                  subscriberId: '123'
                                  userId: '123'
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 90
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  expiredAt:
                                    type: string
                                    example: null
                                  finishedAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  subscriberId:
                                    type: string
                                    example: '123'
                                  userId:
                                    type: string
                                    example: '123'
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000028
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - 'Free Trial Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: trial_link_id
        description: 'The ID of the trial link.'
        example: at
        required: true
        schema:
          type: string
  '/api/{account}/trial-links/{trial_link_id}/spenders':
    get:
      summary: 'List Free Trial Link Spenders'
      operationId: listFreeTrialLinkSpenders
      description: 'Only available if we already scraped subscribers and calculated revenue per fan'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of spenders to return per page. Default `50`.'
          example: 50
          required: false
          schema:
            type: integer
            description: 'The number of spenders to return per page. Default `50`.'
            example: 50
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`.'
            example: 0
        -
          in: query
          name: minSpend
          description: 'Minimal spend of a fan. Default `1`. Must be at least 1.'
          example: 1.0
          required: false
          schema:
            type: number
            description: 'Minimal spend of a fan. Default `1`. Must be at least 1.'
            example: 1.0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      onlyfans_id: '100000001'
                      username: user_001
                      revenue:
                        total: 26.8
                        calculated_at: '2025-09-29T10:47:19.000000Z'
                    -
                      onlyfans_id: '100000002'
                      username: user_002
                      revenue:
                        total: 109.88
                        calculated_at: '2025-09-29T10:47:19.000000Z'
                    -
                      onlyfans_id: '100000003'
                      username: user_003
                      revenue:
                        total: 32.96
                        calculated_at: '2025-09-29T10:47:19.000000Z'
                  _meta:
                    _credits:
                      used: 1
                      balance: 224802
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49929
                properties:
                  data:
                    type: array
                    example:
                      -
                        onlyfans_id: '100000001'
                        username: user_001
                        revenue:
                          total: 26.8
                          calculated_at: '2025-09-29T10:47:19.000000Z'
                      -
                        onlyfans_id: '100000002'
                        username: user_002
                        revenue:
                          total: 109.88
                          calculated_at: '2025-09-29T10:47:19.000000Z'
                      -
                        onlyfans_id: '100000003'
                        username: user_003
                        revenue:
                          total: 32.96
                          calculated_at: '2025-09-29T10:47:19.000000Z'
                    items:
                      type: object
                      properties:
                        onlyfans_id:
                          type: string
                          example: '100000001'
                        username:
                          type: string
                          example: user_001
                        revenue:
                          type: object
                          properties:
                            total:
                              type: number
                              example: 26.8
                            calculated_at:
                              type: string
                              example: '2025-09-29T10:47:19.000000Z'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224802
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49929
      tags:
        - 'Free Trial Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: trial_link_id
        description: 'The ID of the free trial link to get spenders for'
        example: 123456789
        required: true
        schema:
          type: string
  '/api/{account}/trial-links/{trial_link_id}/stats':
    get:
      summary: 'Get Free Trial Link Stats'
      operationId: getFreeTrialLinkStats
      description: 'Get dashboard-style summary plus daily and monthly metrics for a specific Free Trial Link'
      parameters:
        -
          in: query
          name: date_start
          description: 'Optional stats range start date'
          example: '2026-01-01T00:00:00Z'
          required: false
          schema:
            type: string
            description: 'Optional stats range start date'
            example: '2026-01-01T00:00:00Z'
        -
          in: query
          name: date_end
          description: 'Optional stats range end date'
          example: '2026-01-31T23:59:59Z'
          required: false
          schema:
            type: string
            description: 'Optional stats range end date'
            example: '2026-01-31T23:59:59Z'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      clicks_total: 182
                      subs_total: 123
                      revenue_total: 123.0
                      spenders_total: 16
                      revenue_cached_at: '2026-01-31T23:59:59+00:00'
                    daily_metrics:
                      -
                        timestamp: '2026-01-30'
                        clicks: 5
                        subs: 3
                        revenue: 12.5
                        spenders: 1
                      -
                        timestamp: '2026-01-31'
                        clicks: 8
                        subs: 4
                        revenue: 21.0
                        spenders: 2
                    monthly_metrics:
                      -
                        timestamp: '2026-01-01'
                        clicks: 182
                        subs: 123
                        revenue: 123.0
                        spenders: 16
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          clicks_total:
                            type: integer
                            example: 182
                          subs_total:
                            type: integer
                            example: 123
                          revenue_total:
                            type: number
                            example: 123.0
                          spenders_total:
                            type: integer
                            example: 16
                          revenue_cached_at:
                            type: string
                            example: '2026-01-31T23:59:59+00:00'
                      daily_metrics:
                        type: array
                        example:
                          -
                            timestamp: '2026-01-30'
                            clicks: 5
                            subs: 3
                            revenue: 12.5
                            spenders: 1
                          -
                            timestamp: '2026-01-31'
                            clicks: 8
                            subs: 4
                            revenue: 21
                            spenders: 2
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: '2026-01-30'
                            clicks:
                              type: integer
                              example: 5
                            subs:
                              type: integer
                              example: 3
                            revenue:
                              type: number
                              example: 12.5
                            spenders:
                              type: integer
                              example: 1
                      monthly_metrics:
                        type: array
                        example:
                          -
                            timestamp: '2026-01-01'
                            clicks: 182
                            subs: 123
                            revenue: 123
                            spenders: 16
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: '2026-01-01'
                            clicks:
                              type: integer
                              example: 182
                            subs:
                              type: integer
                              example: 123
                            revenue:
                              type: number
                              example: 123.0
                            spenders:
                              type: integer
                              example: 16
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
      tags:
        - 'Free Trial Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: trial_link_id
        description: 'The ID of the trial link.'
        example: aut
        required: true
        schema:
          type: string
  '/api/{account}/trial-links/{trial_link_id}/cohort-arps':
    get:
      summary: 'Get Free Trial Link Cohort ARPS'
      operationId: getFreeTrialLinkCohortARPS
      description: 'Get per-link time-to-profit cohort ARPS windows for a specific Free Trial Link'
      parameters:
        -
          in: query
          name: acquisition_start
          description: 'Optional acquisition range start date'
          example: '2026-01-01T00:00:00Z'
          required: false
          schema:
            type: string
            description: 'Optional acquisition range start date'
            example: '2026-01-01T00:00:00Z'
        -
          in: query
          name: acquisition_end
          description: 'Optional acquisition range end date'
          example: '2026-01-31T23:59:59Z'
          required: false
          schema:
            type: string
            description: 'Optional acquisition range end date'
            example: '2026-01-31T23:59:59Z'
        -
          in: query
          name: revenue_basis
          description: 'Revenue basis. Defaults to `net`.'
          example: net
          required: false
          schema:
            type: string
            description: 'Revenue basis. Defaults to `net`.'
            example: net
            enum:
              - net
              - gross
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  error: 'Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API key.'
                properties:
                  error:
                    type: string
                    example: 'Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API key.'
      tags:
        - 'Free Trial Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: trial_link_id
        description: 'The ID of the trial link.'
        example: ullam
        required: true
        schema:
          type: string
  '/api/{account}/trial-links/{trial_link_id}/tags':
    get:
      summary: 'List Free Trial Link Tags'
      operationId: listFreeTrialLinkTags
      description: 'Get tags for a specific free trial link. This is a free endpoint.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: 'Free endpoint'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: 'Free endpoint'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
      tags:
        - 'Free Trial Links'
    post:
      summary: 'Add Free Trial Link Tags'
      operationId: addFreeTrialLinkTags
      description: 'Add tags to a specific free trial link. Existing tags are preserved. This is a free endpoint.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - Twitter
                      - TikTok
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: 'Free endpoint'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                          - TikTok
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: 'Free endpoint'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
      tags:
        - 'Free Trial Links'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: 'Array of tag names to add to the trial link.'
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
              required:
                - tags
    delete:
      summary: 'Remove Free Trial Link Tags'
      operationId: removeFreeTrialLinkTags
      description: 'Remove tags from a specific free trial link. This is a free endpoint.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: 'Free endpoint'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: 'Free endpoint'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
      tags:
        - 'Free Trial Links'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: 'Array of tag names to remove from the trial link.'
                  example: '["Instagram"]'
                  items:
                    type: string
              required:
                - tags
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: trial_link_id
        description: 'The ID of the trial link'
        example: 123456789
        required: true
        schema:
          type: integer
  /api/link-tags:
    get:
      summary: 'List All Link Tags'
      operationId: listAllLinkTags
      description: 'Get all existing tags that have been used on free trial links and/or tracking links for this account. This is a free endpoint.'
      parameters:
        -
          in: query
          name: type
          description: 'Filter by link type. If not provided, returns tags for both types.'
          example: trial_links
          required: false
          schema:
            type: string
            description: 'Filter by link type. If not provided, returns tags for both types.'
            example: trial_links
            enum:
              - trial_links
              - tracking_links
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - TikTok
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: 'Free endpoint'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - TikTok
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: 'Free endpoint'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
      tags:
        - 'Link Tags'
  '/api/{account}/mass-messaging/overview':
    get:
      summary: 'Get Mass Message Overview'
      operationId: getMassMessageOverview
      description: 'Get an overview of mass messages, showing the send count and view count.'
      parameters:
        -
          in: query
          name: startDate
          description: 'The earliest mass message to retrieve. Keep empty to get all.'
          example: '2025-01-01 00:00:00'
          required: false
          schema:
            type: string
            description: 'The earliest mass message to retrieve. Keep empty to get all.'
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: endDate
          description: 'The latest mass message to retrieve. Keep empty to get all. MUST BE DATE AFTER `startDate`. This is also used for pagination.'
          example: '2025-03-31 23:59:59'
          required: false
          schema:
            type: string
            description: 'The latest mass message to retrieve. Keep empty to get all. MUST BE DATE AFTER `startDate`. This is also used for pagination.'
            example: '2025-03-31 23:59:59'
        -
          in: query
          name: limit
          description: 'Number of mass messages to return (default = 10)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of mass messages to return (default = 10)'
            example: 10
        -
          in: query
          name: query
          description: 'Optionally, find a mass message by the message text.'
          example: 'My message text'
          required: false
          schema:
            type: string
            description: 'Optionally, find a mass message by the message text.'
            example: 'My message text'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: true
                    items:
                      -
                        id: 123
                        date: '2025-01-01T01:01:01+01:01'
                        responseType: message
                        text: '<p>Text</p>'
                        rawText: '<p>Text</p>'
                        giphyId: null
                        isFree: true
                        isMediaReady: true
                        mediaCount: 1
                        media:
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T01:01:01+01:01'
                            isReady: true
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                width: 2335
                                height: 4175
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                width: 960
                                height: 1717
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              '240': null
                              '720': null
                        previews: []
                        isTip: false
                        isReportedByMe: false
                        viewedCount: 123
                        sentCount: 123
                        isCanceled: false
                        template: group
                        canUnsend: true
                        unsendSeconds: 1000000
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: true
                      items:
                        type: array
                        example:
                          -
                            id: 123
                            date: '2025-01-01T01:01:01+01:01'
                            responseType: message
                            text: '<p>Text</p>'
                            rawText: '<p>Text</p>'
                            giphyId: null
                            isFree: true
                            isMediaReady: true
                            mediaCount: 1
                            media:
                              -
                                id: 123
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: '2025-01-01T01:01:01+01:01'
                                isReady: true
                                files:
                                  full:
                                    url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                    width: 2335
                                    height: 4175
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                    width: 960
                                    height: 1717
                                    size: 0
                                  squarePreview:
                                    url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                    width: 960
                                    height: 960
                                    size: 0
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  240: null
                                  720: null
                            previews: []
                            isTip: false
                            isReportedByMe: false
                            viewedCount: 123
                            sentCount: 123
                            isCanceled: false
                            template: group
                            canUnsend: true
                            unsendSeconds: 1000000
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            date:
                              type: string
                              example: '2025-01-01T01:01:01+01:01'
                            responseType:
                              type: string
                              example: message
                            text:
                              type: string
                              example: '<p>Text</p>'
                            rawText:
                              type: string
                              example: '<p>Text</p>'
                            giphyId:
                              type: string
                              example: null
                            isFree:
                              type: boolean
                              example: true
                            isMediaReady:
                              type: boolean
                              example: true
                            mediaCount:
                              type: integer
                              example: 1
                            media:
                              type: array
                              example:
                                -
                                  id: 123
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: '2025-01-01T01:01:01+01:01'
                                  isReady: true
                                  files:
                                    full:
                                      url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                      width: 2335
                                      height: 4175
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                      width: 960
                                      height: 1717
                                      size: 0
                                    squarePreview:
                                      url: 'https://cdn2.onlyfans.com/files/.../image.jpg'
                                      width: 960
                                      height: 960
                                      size: 0
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    240: null
                                    720: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T01:01:01+01:01'
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/.../image.jpg' }, width: { type: integer, example: 2335 }, height: { type: integer, example: 4175 }, size: { type: integer, example: 0 }, sources: { type: array, example: [] } } }
                                      thumb: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/.../image.jpg' }, width: { type: integer, example: 300 }, height: { type: integer, example: 300 }, size: { type: integer, example: 0 } } }
                                      preview: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/.../image.jpg' }, width: { type: integer, example: 960 }, height: { type: integer, example: 1717 }, size: { type: integer, example: 0 } } }
                                      squarePreview: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/.../image.jpg' }, width: { type: integer, example: 960 }, height: { type: integer, example: 960 }, size: { type: integer, example: 0 } } }
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      240: { type: string, example: null }
                                      720: { type: string, example: null }
                            previews:
                              type: array
                              example: []
                            isTip:
                              type: boolean
                              example: false
                            isReportedByMe:
                              type: boolean
                              example: false
                            viewedCount:
                              type: integer
                              example: 123
                            sentCount:
                              type: integer
                              example: 123
                            isCanceled:
                              type: boolean
                              example: false
                            template:
                              type: string
                              example: group
                            canUnsend:
                              type: boolean
                              example: true
                            unsendSeconds:
                              type: integer
                              example: 1000000
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Mass Messaging'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/mass-messaging':
    get:
      summary: 'List Mass Message Queue'
      operationId: listMassMessageQueue
      description: 'List the pending or recently sent mass messages in the message queue.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 123
                      date: '2025-01-01T01:01:01+00:00'
                      isReady: true
                      isDone: false
                      total: -1
                      pending: 2
                      canUnsend: true
                      unsendSeconds: 1000000
                      hasError: false
                      isCanceled: false
                      isCouplePeopleMedia: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 964
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49989
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 123
                        date: '2025-01-01T01:01:01+00:00'
                        isReady: true
                        isDone: false
                        total: -1
                        pending: 2
                        canUnsend: true
                        unsendSeconds: 1000000
                        hasError: false
                        isCanceled: false
                        isCouplePeopleMedia: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        date:
                          type: string
                          example: '2025-01-01T01:01:01+00:00'
                        isReady:
                          type: boolean
                          example: true
                        isDone:
                          type: boolean
                          example: false
                        total:
                          type: integer
                          example: -1
                        pending:
                          type: integer
                          example: 2
                        canUnsend:
                          type: boolean
                          example: true
                        unsendSeconds:
                          type: integer
                          example: 1000000
                        hasError:
                          type: boolean
                          example: false
                        isCanceled:
                          type: boolean
                          example: false
                        isCouplePeopleMedia:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 964
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49989
      tags:
        - 'Mass Messaging'
    post:
      summary: 'Send Mass Message'
      operationId: sendMassMessage
      description: 'Send a mass message to lists and/or users. You may use both the `userLists` and `userIds` parameters to send the same message to both lists and individual users.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    date: '2025-01-01T01:01:01+00:00'
                    isReady: true
                    isDone: false
                    total: -1
                    pending: 0
                    canUnsend: true
                    unsendSeconds: 1000000
                    hasError: false
                    isCanceled: false
                    isCouplePeopleMedia: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 967
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      date:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isReady:
                        type: boolean
                        example: true
                      isDone:
                        type: boolean
                        example: false
                      total:
                        type: integer
                        example: -1
                      pending:
                        type: integer
                        example: 0
                      canUnsend:
                        type: boolean
                        example: true
                      unsendSeconds:
                        type: integer
                        example: 1000000
                      hasError:
                        type: boolean
                        example: false
                      isCanceled:
                        type: boolean
                        example: false
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 967
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - 'Mass Messaging'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                userLists:
                  type: array
                  description: 'Array of user list IDs that the mass message will be sent to.'
                  example:
                    - fans
                    - recent
                    - following
                    - rebill_off
                    - tagged
                    - 1234567890
                  items:
                    type: string
                excludedLists:
                  type: array
                  description: 'Array of user list IDs that the mass message will NOT be sent to.'
                  example:
                    - fans
                    - recent
                    - following
                    - rebill_off
                    - tagged
                    - 1234567890
                  items:
                    type: string
                userIds:
                  type: array
                  description: 'Array of user IDs that the mass message will be sent to.'
                  example:
                    - 1234567890
                  items:
                    type: string
                text:
                  type: string
                  description: 'The message text content'
                  example: Hello!
                lockedText:
                  type: boolean
                  description: 'Whether the text should be shown or hidden'
                  example: true
                price:
                  type: integer
                  description: 'Price for paid content (0 or between 3-200). In case this is not zero, **mediaFiles** is required'
                  example: 100
                mediaFiles:
                  type: array
                  description: 'Direct file uploads, OFAPI `ofapi_media_` IDs, or OF vault IDs. Will be hidden if `price` is provided.'
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: 'file[]|string'
                previews:
                  type: array
                  description: 'Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or integer indices referencing uploaded files in `mediaFiles`. Will be shown if `price` is provided.'
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: 'file[]|string[]|int'
                scheduledDate:
                  type: string
                  description: 'Schedule the chat message in the future (UTC timezone).'
                  example: '2025-01-01T00:00:00.000Z'
                saveForLater:
                  type: boolean
                  description: 'Add your message to the "Saved for later" queue.'
                  example: true
              required:
                - text
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/mass-messaging/{id}':
    get:
      summary: 'Get Mass Message'
      operationId: getMassMessage
      description: 'Get the content of a mass message.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    queue:
                      id: 123
                      date: '2025-01-01T01:01:01+00:00'
                      text: 'My message'
                      giphyId: null
                      textCropped: 'My message'
                      isFree: true
                      sentCount: 2
                      viewedCount: 0
                      canUnsend: false
                      unsendSeconds: 0
                      isCanceled: true
                      mediaTypes: null
                      hasError: false
                      releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 955
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49980
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      queue:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          date:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          text:
                            type: string
                            example: 'My message'
                          giphyId:
                            type: string
                            example: null
                          textCropped:
                            type: string
                            example: 'My message'
                          isFree:
                            type: boolean
                            example: true
                          sentCount:
                            type: integer
                            example: 2
                          viewedCount:
                            type: integer
                            example: 0
                          canUnsend:
                            type: boolean
                            example: false
                          unsendSeconds:
                            type: integer
                            example: 0
                          isCanceled:
                            type: boolean
                            example: true
                          mediaTypes:
                            type: string
                            example: null
                          hasError:
                            type: boolean
                            example: false
                          releaseForms:
                            type: array
                            example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 955
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49980
      tags:
        - 'Mass Messaging'
    put:
      summary: 'Update Mass Message'
      operationId: updateMassMessage
      description: 'Update a mass message.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    date: '2025-01-01T01:01:01+01:01'
                    isReady: true
                    isDone: false
                    total: -1
                    pending: 0
                    canUnsend: true
                    unsendSeconds: 1000000
                    hasError: false
                    isCanceled: false
                    isCouplePeopleMedia: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999919
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49942
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      date:
                        type: string
                        example: '2025-01-01T01:01:01+01:01'
                      isReady:
                        type: boolean
                        example: true
                      isDone:
                        type: boolean
                        example: false
                      total:
                        type: integer
                        example: -1
                      pending:
                        type: integer
                        example: 0
                      canUnsend:
                        type: boolean
                        example: true
                      unsendSeconds:
                        type: integer
                        example: 1000000
                      hasError:
                        type: boolean
                        example: false
                      isCanceled:
                        type: boolean
                        example: false
                      isCouplePeopleMedia:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999919
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49942
      tags:
        - 'Mass Messaging'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                userLists:
                  type: array
                  description: 'Array of user list IDs that the mass message will be sent to.'
                  example:
                    - fans
                    - recent
                    - following
                    - rebill_off
                    - tagged
                    - 1234567890
                  items:
                    type: string
                userIds:
                  type: array
                  description: 'Array of user IDs that the mass message will be sent to.'
                  example:
                    - 1234567890
                  items:
                    type: string
                text:
                  type: string
                  description: 'The message text content'
                  example: Hello!
                lockedText:
                  type: boolean
                  description: 'Whether the text should be shown or hidden'
                  example: true
                price:
                  type: integer
                  description: 'Price for paid content (0 or between 3-200). In case this is not zero, **mediaFiles** is required'
                  example: 100
                mediaFiles:
                  type: array
                  description: 'Array of media file upload prefixed_ids, or OF media IDs (required if price is not 0). Will be hidden if `price` is provided.'
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: string
                previews:
                  type: array
                  description: 'Array of media file upload prefixed_ids, or OF media IDs (required if price is not 0). Will be shown if `price` is provided. All `previews` values must also exist in the `mediaFiles` array.'
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: string
                scheduledDate:
                  type: string
                  description: 'Schedule the chat message in the future (UTC timezone).'
                  example: '2025-01-01T00:00:00.000Z'
              required:
                - text
    delete:
      summary: 'Unsend/Delete Mass Message'
      operationId: unsendDeleteMassMessage
      description: 'Unsend a recently sent mass message, or delete a scheduled/saved message. When unsending, purchased content will continue to be able to viewable.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    queue:
                      id: 123
                      date: '2025-01-01T01:01:01+00:00'
                      text: 'My message'
                      giphyId: null
                      textCropped: 'My message'
                      isFree: true
                      sentCount: 2
                      viewedCount: 0
                      canUnsend: false
                      unsendSeconds: 0
                      isCanceled: true
                      mediaTypes: null
                      hasError: false
                      releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 955
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49980
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      queue:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          date:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          text:
                            type: string
                            example: 'My message'
                          giphyId:
                            type: string
                            example: null
                          textCropped:
                            type: string
                            example: 'My message'
                          isFree:
                            type: boolean
                            example: true
                          sentCount:
                            type: integer
                            example: 2
                          viewedCount:
                            type: integer
                            example: 0
                          canUnsend:
                            type: boolean
                            example: false
                          unsendSeconds:
                            type: integer
                            example: 0
                          isCanceled:
                            type: boolean
                            example: true
                          mediaTypes:
                            type: string
                            example: null
                          hasError:
                            type: boolean
                            example: false
                          releaseForms:
                            type: array
                            example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 955
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49980
      tags:
        - 'Mass Messaging'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: id
        description: 'The ID of the message queue item. Can be retrieved from the above store and list endpoints.'
        example: 1234567890
        required: true
        schema:
          type: string
  '/api/{account}/media/upload':
    post:
      summary: 'Upload media to the OnlyFans CDN'
      operationId: uploadMediaToTheOnlyFansCDN
      description: 'The response can be used **only once** to manually include media in a post or message. This endpoint does not upload media to the Vault.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  prefixed_id: ofapi_media_123
                  file_name: MyPhoto.png
                  processId: a9k3l2m7n8p0q4r5s6t
                  host: convert1.onlyfans.com
                  sourceUrl: 'https://of2transcoder.s3.amazonaws.com/upload/642a4d7e-134e-4cb4-99b5-6774248341c2/57141494436/file_name.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=token&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=credentials&X-Amz-Date=20250521T151119Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=signature'
                  extra: YW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZA==
                  additional:
                    user: '123'
                  thumbs:
                    -
                      id: 1
                      url: 'https://cdn2.onlyfans.com/files/f/f0/fsdnjdsnf3k2rk/300x300_fjkdnknk23efsknj.jpg?Expires=1750518679&Signature=signature&Key-Pair-Id=PAIRID'
                properties:
                  prefixed_id:
                    type: string
                    example: ofapi_media_123
                  file_name:
                    type: string
                    example: MyPhoto.png
                  processId:
                    type: string
                    example: a9k3l2m7n8p0q4r5s6t
                  host:
                    type: string
                    example: convert1.onlyfans.com
                  sourceUrl:
                    type: string
                    example: 'https://of2transcoder.s3.amazonaws.com/upload/642a4d7e-134e-4cb4-99b5-6774248341c2/57141494436/file_name.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=token&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=credentials&X-Amz-Date=20250521T151119Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Signature=signature'
                  extra:
                    type: string
                    example: YW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZCBzdHJpbmcgYW4gZW5jb2RlZA==
                  additional:
                    type: object
                    properties:
                      user:
                        type: string
                        example: '123'
                  thumbs:
                    type: array
                    example:
                      -
                        id: 1
                        url: 'https://cdn2.onlyfans.com/files/f/f0/fsdnjdsnf3k2rk/300x300_fjkdnknk23efsknj.jpg?Expires=1750518679&Signature=signature&Key-Pair-Id=PAIRID'
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        url:
                          type: string
                          example: 'https://cdn2.onlyfans.com/files/f/f0/fsdnjdsnf3k2rk/300x300_fjkdnknk23efsknj.jpg?Expires=1750518679&Signature=signature&Key-Pair-Id=PAIRID'
      tags:
        - Media
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: 'The file to upload.'
                type:
                  type: string
                  description: 'Set to `avatar` if this file will be used as a profile picture, `header` for a profile banner, or keep empty if this file will be for anything else.'
                  example: avatar
                  enum:
                    - default
                    - avatar
                    - header
              required:
                - file
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/media/scrape':
    post:
      summary: '[Deprecated] Scrape media from the OnlyFans CDN'
      operationId: DeprecatedScrapeMediaFromTheOnlyFansCDN
      description: '**⚠️ This is a deprecated endpoint. Please use the new "Download media from the OnlyFans CDN" endpoint!** Scrapes a `https://cdn*.onlyfans.com/*` URL *or* Vault Media ID, and uploads it to the OnlyFans API CDN, where you can view or download the file. **Max file size is 500MB**'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  temporary_url: 'https://ofapi-media-prod.nyc3.digitaloceanspaces.com/123/600x400_123.jpg'
                  expiration_date: '2025-01-01T00:00:00.000000Z'
                properties:
                  temporary_url:
                    type: string
                    example: 'https://ofapi-media-prod.nyc3.digitaloceanspaces.com/123/600x400_123.jpg'
                  expiration_date:
                    type: string
                    example: '2025-01-01T00:00:00.000000Z'
        500:
          description: 'The provided CDN URL is expired, invalid, or the file is not available anymore.'
          content:
            application/json:
              schema:
                type: object
                example:
                  error: ONLYFANS_COM_ERROR
                  message: 'OnlyFans returned an unknown error.: [403]'
                  description: 'This error happened most probably because of a bug in the OnlyFans.com API or you sent wrong parameters (like a non-existing user id).'
                  onlyfans_response:
                    status: 403
                    body: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 123
                      note: 'OnlyFans returned an error, but we still had to make an API request to OnlyFans.com'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 50000
                properties:
                  error:
                    type: string
                    example: ONLYFANS_COM_ERROR
                  message:
                    type: string
                    example: 'OnlyFans returned an unknown error.: [403]'
                  description:
                    type: string
                    example: 'This error happened most probably because of a bug in the OnlyFans.com API or you sent wrong parameters (like a non-existing user id).'
                  onlyfans_response:
                    type: object
                    properties:
                      status:
                        type: integer
                        example: 403
                      body:
                        type: string
                        example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 123
                          note:
                            type: string
                            example: 'OnlyFans returned an error, but we still had to make an API request to OnlyFans.com'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 50000
      tags:
        - Media
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: 'The CDN URL to scrape. **Keep in mind that these URLs expire fast.**'
                  example: 'https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123'
                  nullable: true
                media_id:
                  type: integer
                  description: 'The OnlyFans Vault Media ID. **Can be used instead of the `url`.**'
                  example: 1234567890
                  nullable: true
                file_type:
                  type: string
                  description: 'The file type to scrape. Only allowed when using `media_id`.'
                  example: full
                  enum:
                    - full
                    - thumb
                    - preview
                    - squarePreview
                  nullable: true
                expiration_date:
                  type: string
                  description: 'The expiration date of our returned `temporary_url`. Default of 5 minutes. Must be null if `public` is true.'
                  example: '2025-01-01 00:00:00'
                  nullable: true
                public:
                  type: boolean
                  description: 'Set to true if you want to have the file uploaded to our public CDN (no signed URL needed to access). Default is false. Must be null if `expiration_date` is set.'
                  example: false
                  nullable: true
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/media/download/{cdnUrl}':
    get:
      summary: 'Download Media from the OnlyFans CDN'
      operationId: downloadMediaFromTheOnlyFansCDN
      description: 'Downloads a file directly from `https://cdn*.onlyfans.com/*` URL. Use this endpoint to directly download a file from URL.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: '<Streamed binary of the downloaded file>'
      tags:
        - Media
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                cdnUrl:
                  type: string
                  description: 'Must be a valid URL. Must match the regex /^https?:\/\/(?:[a-zA-Z0-9-]+\.)*onlyfans\.com(?=\/.'
                  example: 'http://:xQA4m.):nFsbr.):YYhow.):JNCAR.):GG4iq.):rs0wo.)onlyfans.com(='
              required:
                - cdnUrl
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: cdnUrl
        description: 'Optional parameter. The CDN URL to scrape. **Keep in mind that these URLs expire in approx. 20 minutes.** So for example, if you fetched Media Vault Items at 01:00pm, the URLs will expire at around 01:20pm'
        required: true
        schema:
          type: string
        examples:
          omitted:
            summary: 'When the value is omitted'
            value: ''
          present:
            summary: 'When the value is present'
            value: 'https://cdn2.onlyfans.com/files/e/e5/123/600x400_123.jpg?Tag=2&u=123&Policy=123&Signature=signature&Key-Pair-Id=123'
  '/api/{account}/media/vault/delete-media':
    delete:
      summary: 'Delete Vault Media'
      operationId: deleteVaultMedia
      description: 'Delete one or multiple media from your vault.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 981
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49926
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 981
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49926
      tags:
        - 'Media Vault'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaIds:
                  type: array
                  description: 'Array of media IDs to delete.'
                  example:
                    - 1234567890
                  items:
                    type: string
              required:
                - mediaIds
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/media/vault':
    get:
      summary: 'List Vault Media'
      operationId: listVaultMedia
      description: 'List media items stored in your vault. See how many likes and how much tips did they get.'
      parameters:
        -
          in: query
          name: query
          description: 'Optionally, search for a text query.'
          example: Hi
          required: false
          schema:
            type: string
            description: 'Optionally, search for a text query.'
            example: Hi
            nullable: true
        -
          in: query
          name: field
          description: 'Sort the results by a field. Default `recent`'
          example: recent
          required: false
          schema:
            type: string
            description: 'Sort the results by a field. Default `recent`'
            example: recent
            enum:
              - recent
              - most-liked
              - highest-tips
        -
          in: query
          name: type
          description: 'Filter the results by a media type. Keep empty to show all media.'
          example: photo
          required: false
          schema:
            type: string
            description: 'Filter the results by a media type. Keep empty to show all media.'
            example: photo
            enum:
              - photo
              - gif
              - video
              - audio
        -
          in: query
          name: list
          description: 'Only show media items from a specific list (category). **Refer to our Media Vault Lists endpoints.**'
          example: '123456789'
          required: false
          schema:
            type: integer
            description: 'Only show media items from a specific list (category). **Refer to our Media Vault Lists endpoints.**'
            example: '123456789'
        -
          in: query
          name: sort
          description: 'Sort the results. Default `desc`'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort the results. Default `desc`'
            example: desc
            enum:
              - desc
              - asc
        -
          in: query
          name: limit
          description: 'Number of media to return per page. Default: `24`'
          example: 24
          required: false
          schema:
            type: integer
            description: 'Number of media to return per page. Default: `24`'
            example: 24
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: false
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        type: audio
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 3
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: audio
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 3
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 2048
                            height: 1360
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 638
                            size: 0
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 2048
                            height: 1360
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 638
                            size: 0
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 1629
                            height: 1629
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 1629
                            height: 1629
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 1629
                            height: 1629
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 1629
                            height: 1629
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 500
                            height: 500
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 500
                            height: 500
                            size: 0
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: true
                        counters:
                          likesCount: 0
                          tipsSumm: 0
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 1280
                            height: 720
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 540
                            size: 0
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                        duration: 0
                        hasPosts: false
                        listStates:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        releaseForms: []
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999960
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49989
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            type: audio
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 0
                                height: 0
                                size: 0
                                sources: []
                              thumb: null
                              preview: null
                              squarePreview: null
                            duration: 3
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: audio
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 0
                                height: 0
                                size: 0
                                sources: []
                              thumb: null
                              preview: null
                              squarePreview: null
                            duration: 3
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 2048
                                height: 1360
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 638
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 2048
                                height: 1360
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 638
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 1629
                                height: 1629
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 1629
                                height: 1629
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 1629
                                height: 1629
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 1629
                                height: 1629
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 500
                                height: 500
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 500
                                height: 500
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: true
                            counters:
                              likesCount: 0
                              tipsSumm: 0
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 1280
                                height: 720
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 540
                                size: 0
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                            duration: 0
                            hasPosts: false
                            listStates:
                              -
                                id: 123
                                type: posts
                                name: Posts
                                hasMedia: true
                                canAddMedia: false
                              -
                                id: 123
                                type: stories
                                name: Stories
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: messages
                                name: Messages
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: streams
                                name: Streams
                                hasMedia: false
                                canAddMedia: false
                              -
                                id: 123
                                type: custom
                                name: 'custom category'
                                hasMedia: false
                                canAddMedia: true
                              -
                                id: 123
                                type: media_stickers
                                name: Uploads
                                hasMedia: false
                                canAddMedia: false
                            releaseForms: []
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: audio
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isReady:
                              type: boolean
                              example: true
                            counters:
                              type: object
                              properties:
                                likesCount:
                                  type: integer
                                  example: 0
                                tipsSumm:
                                  type: integer
                                  example: 0
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: 'https://cdn2.onlyfans.com/files/...'
                                    width:
                                      type: integer
                                      example: 0
                                    height:
                                      type: integer
                                      example: 0
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: string
                                  example: null
                                preview:
                                  type: string
                                  example: null
                                squarePreview:
                                  type: string
                                  example: null
                            duration:
                              type: integer
                              example: 3
                            hasPosts:
                              type: boolean
                              example: false
                            listStates:
                              type: array
                              example:
                                -
                                  id: 123
                                  type: posts
                                  name: Posts
                                  hasMedia: false
                                  canAddMedia: false
                                -
                                  id: 123
                                  type: stories
                                  name: Stories
                                  hasMedia: false
                                  canAddMedia: false
                                -
                                  id: 123
                                  type: messages
                                  name: Messages
                                  hasMedia: true
                                  canAddMedia: false
                                -
                                  id: 123
                                  type: streams
                                  name: Streams
                                  hasMedia: false
                                  canAddMedia: false
                                -
                                  id: 123
                                  type: custom
                                  name: 'custom category'
                                  hasMedia: false
                                  canAddMedia: true
                                -
                                  id: 123
                                  type: media_stickers
                                  name: Uploads
                                  hasMedia: false
                                  canAddMedia: false
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: posts
                                  name:
                                    type: string
                                    example: Posts
                                  hasMedia:
                                    type: boolean
                                    example: false
                                  canAddMedia:
                                    type: boolean
                                    example: false
                            releaseForms:
                              type: array
                              example: []
                            hasCustomPreview:
                              type: boolean
                              example: false
                            videoSources:
                              type: object
                              properties:
                                240:
                                  type: string
                                  example: null
                                720:
                                  type: string
                                  example: null
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999960
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49989
      tags:
        - 'Media Vault'
    post:
      summary: 'Upload Media to Vault'
      operationId: uploadMediaToVault
      description: 'Upload a media file directly to your vault.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: photo
                    convertedToVideo: false
                    canView: true
                    hasError: false
                    createdAt: '2026-01-01T01:01:01+00:00'
                    isReady: false
                    files:
                      full:
                        url: null
                        width: 0
                        height: 0
                        size: 0
                        sources: []
                      thumb: null
                      preview: null
                      squarePreview: null
                    duration: 0
                    releaseForms: []
                    hasCustomPreview: false
                  _meta:
                    _credits:
                      used: 3
                      balance: 999970
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: photo
                      convertedToVideo:
                        type: boolean
                        example: false
                      canView:
                        type: boolean
                        example: true
                      hasError:
                        type: boolean
                        example: false
                      createdAt:
                        type: string
                        example: '2026-01-01T01:01:01+00:00'
                      isReady:
                        type: boolean
                        example: false
                      files:
                        type: object
                        properties:
                          full:
                            type: object
                            properties:
                              url:
                                type: string
                                example: null
                              width:
                                type: integer
                                example: 0
                              height:
                                type: integer
                                example: 0
                              size:
                                type: integer
                                example: 0
                              sources:
                                type: array
                                example: []
                          thumb:
                            type: string
                            example: null
                          preview:
                            type: string
                            example: null
                          squarePreview:
                            type: string
                            example: null
                      duration:
                        type: integer
                        example: 0
                      releaseForms:
                        type: array
                        example: []
                      hasCustomPreview:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 3
                          balance:
                            type: integer
                            example: 999970
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Media Vault'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: 'The file to upload to the vault.'
              required:
                - file
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/media/vault/{media_id}':
    get:
      summary: 'Get Vault Media'
      operationId: getVaultMedia
      description: 'Retrieve details about a specific media item in your vault.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 12345678
                    type: photo
                    convertedToVideo: false
                    canView: true
                    hasError: false
                    createdAt: '2025-01-01T00:00:00+00:00'
                    isReady: true
                    files:
                      full:
                        url: 'https://cdn2.onlyfans.com/files/1/15/.../....jpg'
                        width: 1280
                        height: 720
                        size: 0
                        sources: []
                      thumb:
                        url: 'https://cdn2.onlyfans.com/files/5/56/.../...jpg'
                        width: 300
                        height: 300
                        size: 0
                      preview:
                        url: 'https://cdn2.onlyfans.com/files/7/76/.../...jpg'
                        width: 960
                        height: 540
                        size: 0
                      squarePreview:
                        url: 'https://cdn2.onlyfans.com/files/4/48/.../...jpg'
                        width: 960
                        height: 960
                        size: 0
                    duration: 0
                    hasPosts: false
                    listStates:
                      -
                        id: 123
                        type: posts
                        name: Posts
                        hasMedia: true
                        canAddMedia: false
                      -
                        id: 123
                        type: stories
                        name: Stories
                        hasMedia: false
                        canAddMedia: false
                      -
                        id: 123
                        type: messages
                        name: Messages
                        hasMedia: false
                        canAddMedia: false
                      -
                        id: 123
                        type: streams
                        name: Streams
                        hasMedia: false
                        canAddMedia: false
                      -
                        id: 123
                        type: custom
                        name: 'Special posts'
                        hasMedia: false
                        canAddMedia: true
                      -
                        id: 123
                        type: media_stickers
                        name: Uploads
                        hasMedia: false
                        canAddMedia: false
                    hasCustomPreview: false
                    videoSources:
                      '240': null
                      '720': null
                  _meta:
                    _credits:
                      used: 1
                      balance: 563
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49991
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 12345678
                      type:
                        type: string
                        example: photo
                      convertedToVideo:
                        type: boolean
                        example: false
                      canView:
                        type: boolean
                        example: true
                      hasError:
                        type: boolean
                        example: false
                      createdAt:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      isReady:
                        type: boolean
                        example: true
                      files:
                        type: object
                        properties:
                          full:
                            type: object
                            properties:
                              url:
                                type: string
                                example: 'https://cdn2.onlyfans.com/files/1/15/.../....jpg'
                              width:
                                type: integer
                                example: 1280
                              height:
                                type: integer
                                example: 720
                              size:
                                type: integer
                                example: 0
                              sources:
                                type: array
                                example: []
                          thumb:
                            type: object
                            properties:
                              url:
                                type: string
                                example: 'https://cdn2.onlyfans.com/files/5/56/.../...jpg'
                              width:
                                type: integer
                                example: 300
                              height:
                                type: integer
                                example: 300
                              size:
                                type: integer
                                example: 0
                          preview:
                            type: object
                            properties:
                              url:
                                type: string
                                example: 'https://cdn2.onlyfans.com/files/7/76/.../...jpg'
                              width:
                                type: integer
                                example: 960
                              height:
                                type: integer
                                example: 540
                              size:
                                type: integer
                                example: 0
                          squarePreview:
                            type: object
                            properties:
                              url:
                                type: string
                                example: 'https://cdn2.onlyfans.com/files/4/48/.../...jpg'
                              width:
                                type: integer
                                example: 960
                              height:
                                type: integer
                                example: 960
                              size:
                                type: integer
                                example: 0
                      duration:
                        type: integer
                        example: 0
                      hasPosts:
                        type: boolean
                        example: false
                      listStates:
                        type: array
                        example:
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canAddMedia: false
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canAddMedia: false
                          -
                            id: 123
                            type: custom
                            name: 'Special posts'
                            hasMedia: false
                            canAddMedia: true
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canAddMedia: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: posts
                            name:
                              type: string
                              example: Posts
                            hasMedia:
                              type: boolean
                              example: true
                            canAddMedia:
                              type: boolean
                              example: false
                      hasCustomPreview:
                        type: boolean
                        example: false
                      videoSources:
                        type: object
                        properties:
                          240:
                            type: string
                            example: null
                          720:
                            type: string
                            example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 563
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49991
      tags:
        - 'Media Vault'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: media_id
        description: 'The ID of the media item to retrieve.'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/media/vault/lists':
    get:
      summary: 'List Vault Lists'
      operationId: listVaultLists
      description: 'List your Vault lists (categories).'
      parameters:
        -
          in: query
          name: query
          description: 'Optionally, find a list by its name.'
          example: 'My list name'
          required: false
          schema:
            type: string
            description: 'Optionally, find a list by its name.'
            example: 'My list name'
        -
          in: query
          name: limit
          description: 'Number of media to return per page. Default: `24`'
          example: 24
          required: false
          schema:
            type: integer
            description: 'Number of media to return per page. Default: `24`'
            example: 24
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: false
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        type: stories
                        name: Stories
                        hasMedia: false
                        canUpdate: false
                        canDelete: false
                        videosCount: 0
                        photosCount: 0
                        gifsCount: 0
                        audiosCount: 0
                        medias: []
                      -
                        id: 123
                        type: streams
                        name: Streams
                        hasMedia: false
                        canUpdate: false
                        canDelete: false
                        videosCount: 0
                        photosCount: 0
                        gifsCount: 0
                        audiosCount: 0
                        medias: []
                      -
                        id: 123
                        type: media_stickers
                        name: Uploads
                        hasMedia: false
                        canUpdate: false
                        canDelete: false
                        videosCount: 0
                        photosCount: 0
                        gifsCount: 0
                        audiosCount: 0
                        medias: []
                      -
                        id: 123
                        type: posts
                        name: Posts
                        hasMedia: true
                        canUpdate: false
                        canDelete: false
                        videosCount: 0
                        photosCount: 5
                        gifsCount: 0
                        audiosCount: 0
                        medias:
                          -
                            type: photo
                            url: 'https://cdn2.onlyfans.com/files/...'
                      -
                        id: 123
                        type: custom
                        name: 'custom category'
                        hasMedia: false
                        canUpdate: true
                        canDelete: true
                        videosCount: 0
                        photosCount: 0
                        gifsCount: 0
                        audiosCount: 0
                        medias: []
                      -
                        id: 123
                        type: messages
                        name: Messages
                        hasMedia: true
                        canUpdate: false
                        canDelete: false
                        videosCount: 1
                        photosCount: 4
                        gifsCount: 0
                        audiosCount: 2
                        medias:
                          -
                            type: photo
                            url: 'https://cdn2.onlyfans.com/files/...'
                    all:
                      videosCount: 1
                      photosCount: 9
                      gifsCount: 0
                      audiosCount: 2
                      medias:
                        -
                          type: photo
                          url: 'https://cdn2.onlyfans.com/files/...'
                    hasMore: false
                    canCreateVaultLists: true
                    order: asc
                    sort: default
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999945
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49968
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            type: stories
                            name: Stories
                            hasMedia: false
                            canUpdate: false
                            canDelete: false
                            videosCount: 0
                            photosCount: 0
                            gifsCount: 0
                            audiosCount: 0
                            medias: []
                          -
                            id: 123
                            type: streams
                            name: Streams
                            hasMedia: false
                            canUpdate: false
                            canDelete: false
                            videosCount: 0
                            photosCount: 0
                            gifsCount: 0
                            audiosCount: 0
                            medias: []
                          -
                            id: 123
                            type: media_stickers
                            name: Uploads
                            hasMedia: false
                            canUpdate: false
                            canDelete: false
                            videosCount: 0
                            photosCount: 0
                            gifsCount: 0
                            audiosCount: 0
                            medias: []
                          -
                            id: 123
                            type: posts
                            name: Posts
                            hasMedia: true
                            canUpdate: false
                            canDelete: false
                            videosCount: 0
                            photosCount: 5
                            gifsCount: 0
                            audiosCount: 0
                            medias:
                              -
                                type: photo
                                url: 'https://cdn2.onlyfans.com/files/...'
                          -
                            id: 123
                            type: custom
                            name: 'custom category'
                            hasMedia: false
                            canUpdate: true
                            canDelete: true
                            videosCount: 0
                            photosCount: 0
                            gifsCount: 0
                            audiosCount: 0
                            medias: []
                          -
                            id: 123
                            type: messages
                            name: Messages
                            hasMedia: true
                            canUpdate: false
                            canDelete: false
                            videosCount: 1
                            photosCount: 4
                            gifsCount: 0
                            audiosCount: 2
                            medias:
                              -
                                type: photo
                                url: 'https://cdn2.onlyfans.com/files/...'
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: stories
                            name:
                              type: string
                              example: Stories
                            hasMedia:
                              type: boolean
                              example: false
                            canUpdate:
                              type: boolean
                              example: false
                            canDelete:
                              type: boolean
                              example: false
                            videosCount:
                              type: integer
                              example: 0
                            photosCount:
                              type: integer
                              example: 0
                            gifsCount:
                              type: integer
                              example: 0
                            audiosCount:
                              type: integer
                              example: 0
                            medias:
                              type: array
                              example: []
                      all:
                        type: object
                        properties:
                          videosCount:
                            type: integer
                            example: 1
                          photosCount:
                            type: integer
                            example: 9
                          gifsCount:
                            type: integer
                            example: 0
                          audiosCount:
                            type: integer
                            example: 2
                          medias:
                            type: array
                            example:
                              -
                                type: photo
                                url: 'https://cdn2.onlyfans.com/files/...'
                            items:
                              type: object
                              properties:
                                type:
                                  type: string
                                  example: photo
                                url:
                                  type: string
                                  example: 'https://cdn2.onlyfans.com/files/...'
                      hasMore:
                        type: boolean
                        example: false
                      canCreateVaultLists:
                        type: boolean
                        example: true
                      order:
                        type: string
                        example: asc
                      sort:
                        type: string
                        example: default
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999945
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49968
      tags:
        - 'Media Vault Lists'
    post:
      summary: 'Create Vault List'
      operationId: createVaultList
      description: 'Create a new Vault list.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: 'My new list'
                    hasMedia: false
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 0
                    gifsCount: 0
                    audiosCount: 0
                    medias: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 994
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49943
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'My new list'
                      hasMedia:
                        type: boolean
                        example: false
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 994
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49943
      tags:
        - 'Media Vault Lists'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'The name of your new list'
                  example: 'My new list'
              required:
                - name
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/media/vault/lists/{list_id}':
    get:
      summary: 'Show Vault List'
      operationId: showVaultList
      description: 'Show a Vault list.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: 'My list'
                    hasMedia: false
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 0
                    gifsCount: 0
                    audiosCount: 0
                    medias: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 989
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49936
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'My list'
                      hasMedia:
                        type: boolean
                        example: false
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 989
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49936
      tags:
        - 'Media Vault Lists'
    put:
      summary: 'Rename Vault List'
      operationId: renameVaultList
      description: 'Rename a Vault list.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: 'My new list name'
                    hasMedia: false
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 0
                    gifsCount: 0
                    audiosCount: 0
                    medias: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 990
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49937
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'My new list name'
                      hasMedia:
                        type: boolean
                        example: false
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 990
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49937
      tags:
        - 'Media Vault Lists'
    delete:
      summary: 'Delete Vault List'
      operationId: deleteVaultList
      description: 'Delete a Vault list.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 992
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49941
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 992
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49941
      tags:
        - 'Media Vault Lists'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: list_id
        description: 'The ID of the list'
        example: '123'
        required: true
        schema:
          type: string
  '/api/{account}/media/vault/lists/{list_id}/media':
    post:
      summary: 'Add Media To List'
      operationId: addMediaToList
      description: 'Add one or multiple media to a list.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: 'My list'
                    hasMedia: true
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 1
                    gifsCount: 0
                    audiosCount: 0
                    medias:
                      -
                        type: photo
                        url: 'https://cdn2.onlyfans.com/files/...'
                  _meta:
                    _credits:
                      used: 1
                      balance: 972
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49917
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'My list'
                      hasMedia:
                        type: boolean
                        example: true
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 1
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example:
                          -
                            type: photo
                            url: 'https://cdn2.onlyfans.com/files/...'
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              example: photo
                            url:
                              type: string
                              example: 'https://cdn2.onlyfans.com/files/...'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 972
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49917
      tags:
        - 'Media Vault Lists'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaIds:
                  type: array
                  description: 'Array of media IDs to add.'
                  example:
                    - 1234567890
                  items:
                    type: string
              required:
                - mediaIds
    delete:
      summary: 'Remove Media From List'
      operationId: removeMediaFromList
      description: 'Remove one or multiple media from a list.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: 'My list'
                    hasMedia: false
                    canUpdate: true
                    canDelete: true
                    videosCount: 0
                    photosCount: 0
                    gifsCount: 0
                    audiosCount: 0
                    medias: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 971
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49916
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'My list'
                      hasMedia:
                        type: boolean
                        example: false
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      videosCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      gifsCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      medias:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 971
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49916
      tags:
        - 'Media Vault Lists'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaIds:
                  type: array
                  description: 'Array of media IDs to delete.'
                  example:
                    - 1234567890
                  items:
                    type: string
              required:
                - mediaIds
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: list_id
        description: 'The ID of the list.'
        example: dolore
        required: true
        schema:
          type: string
  '/api/{account}/notifications':
    get:
      summary: 'List Notifications'
      operationId: listNotifications
      description: 'List all notifications for the account'
      parameters:
        -
          in: query
          name: type
          description: 'Filter notifications by a specific type'
          example: tips
          required: false
          schema:
            type: string
            description: 'Filter notifications by a specific type'
            example: tips
            enum:
              - all
              - subscriptions
              - onlyfans
              - purchases
              - tips
              - tags
              - comments
              - mentions
              - likes
              - promotions
        -
          in: query
          name: limit
          description: 'The number of notifications. Default `10`'
          example: 10
          required: false
          schema:
            type: integer
            description: 'The number of notifications. Default `10`'
            example: 10
        -
          in: query
          name: from_id
          description: "Used for pagination. This value should be the ID of the previous response's last notification."
          example: 123
          required: false
          schema:
            type: integer
            description: "Used for pagination. This value should be the ID of the previous response's last notification."
            example: 123
        -
          in: query
          name: skip_users
          description: 'Whether to skip user details. Default `all`'
          example: all
          required: false
          schema:
            type: string
            description: 'Whether to skip user details. Default `all`'
            example: all
            enum:
              - all
              - none
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        type: subscribed
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isRead: true
                        text: 'subscribed to your profile!'
                        replacePairs:
                          '{SUBSCRIBER_LINK}': "<a href='https://onlyfans.com/username'>Name</a>"
                          '{PRICE}': free
                        subType: new_subscriber_trial
                        canGoToProfile: true
                        user:
                          id: 123
                          _view: 'n'
                    hasMore: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000015
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49973
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            type: subscribed
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isRead: true
                            text: 'subscribed to your profile!'
                            replacePairs:
                              '{SUBSCRIBER_LINK}': "<a href='https://onlyfans.com/username'>Name</a>"
                              '{PRICE}': free
                            subType: new_subscriber_trial
                            canGoToProfile: true
                            user:
                              id: 123
                              _view: 'n'
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: subscribed
                            createdAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isRead:
                              type: boolean
                              example: true
                            text:
                              type: string
                              example: 'subscribed to your profile!'
                            replacePairs:
                              type: object
                              properties:
                                '{SUBSCRIBER_LINK}':
                                  type: string
                                  example: "<a href='https://onlyfans.com/username'>Name</a>"
                                '{PRICE}':
                                  type: string
                                  example: free
                            subType:
                              type: string
                              example: new_subscriber_trial
                            canGoToProfile:
                              type: boolean
                              example: true
                            user:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: 'n'
                      hasMore:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000015
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49973
      tags:
        - Notifications
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/notifications/search-users':
    get:
      summary: 'Search Users In Notifications'
      operationId: searchUsersInNotifications
      description: 'Search users that have appeared in your notifications'
      parameters:
        -
          in: query
          name: query
          description: 'The query to search for. Can be either a name or username.'
          example: User
          required: true
          schema:
            type: string
            description: 'The query to search for. Can be either a name or username.'
            example: User
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      view: x
                      avatar: null
                      avatarThumbs: null
                      header: null
                      headerSize: null
                      headerThumbs: null
                      id: 123
                      name: Name
                      username: username
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: false
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: false
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: false
                      canAddSubscriber: false
                      subscribePrice: 0
                      displayName: ''
                      notice: ''
                      isRestricted: false
                      canRestrict: true
                      subscribedBy: true
                      subscribedByExpire: false
                      subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                      subscribedByAutoprolong: true
                      subscribedIsExpiredNow: false
                      currentSubscribePrice: 0
                      subscribedOn: true
                      subscribedOnExpiredNow: false
                      subscribedOnDuration: '23 days'
                      listsStates:
                        -
                          id: fans
                          type: fans
                          name: Fans
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        -
                          id: following
                          type: following
                          name: Following
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        -
                          id: friends
                          type: friends
                          name: Friends
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: USER_NOT_PERFORMER
                        -
                          id: 1181087239
                          type: custom
                          name: 'Low Spenders-1PM'
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        -
                          id: muted
                          type: muted
                          name: Muted
                          hasUser: false
                          canAddUser: true
                          cannotAddUserReason: null
                        -
                          id: recent
                          type: recent
                          name: 'Recent (last 24 hours)'
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: SYSTEM_LIST
                        -
                          id: rebill_off
                          type: rebill_off
                          name: 'Renew Off'
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: null
                        -
                          id: rebill_on
                          type: rebill_on
                          name: 'Renew On'
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        -
                          id: tagged
                          type: tagged
                          name: Tagged
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: SYSTEM_LIST
                      canReport: true
                      canReceiveChatMessage: true
                      hideChat: false
                      lastSeen: '2025-01-01T00:00:00+00:00'
                      isPerformer: false
                      isRealPerformer: false
                      subscribedByData:
                        price: 0
                        newPrice: 0
                        regularPrice: 0
                        subscribePrice: 0
                        discountPercent: 0
                        discountPeriod: 1
                        subscribeAt: '2025-01-01T00:00:00+00:00'
                        expiredAt: '2025-01-01T00:00:00+00:00'
                        renewedAt: '2025-01-01T00:00:00+00:00'
                        discountFinishedAt: null
                        discountStartedAt: null
                        status: null
                        isMuted: false
                        unsubscribeReason: 'No reason given'
                        duration: '23 days'
                        showPostsInFeed: true
                        subscribes:
                          -
                            id: 123
                            userId: 123
                            subscriberId: 123
                            date: '2025-01-01T00:00:00+00:00'
                            duration: 123
                            startDate: '2025-01-01T00:00:00+00:00'
                            expireDate: '2025-01-01T00:00:00+00:00'
                            cancelDate: null
                            price: 0
                            regularPrice: 0
                            discount: 0
                            earningId: 0
                            action: subscribe
                            type: auto
                            offerStart: null
                            offerEnd: null
                            isCurrent: true
                        hasActivePaidSubscriptions: false
                      subscribedOnData:
                        price: 5
                        newPrice: 20
                        regularPrice: 5
                        subscribePrice: 5
                        discountPercent: 0
                        discountPeriod: 1
                        subscribeAt: '2025-01-01T00:00:00+00:00'
                        expiredAt: '2025-01-01T00:00:00+00:00'
                        renewedAt: '2025-01-01T00:00:00+00:00'
                        discountFinishedAt: null
                        discountStartedAt: null
                        status: null
                        isMuted: false
                        unsubscribeReason: 'No reason given'
                        duration: '23 days'
                        tipsSumm: 0
                        subscribesSumm: 4
                        messagesSumm: 0
                        postsSumm: 0
                        streamsSumm: 0
                        totalSumm: 4
                        lastActivity: '2025-01-01T00:00:00+00:00'
                        recommendations: 0
                        subscribes:
                          -
                            id: 123
                            userId: 213
                            subscriberId: 123
                            date: '2025-01-01T00:00:00+00:00'
                            duration: 30
                            startDate: '2025-01-01T00:00:00+00:00'
                            expireDate: '2025-01-01T00:00:00+00:00'
                            cancelDate: null
                            price: 5
                            regularPrice: 20
                            discount: 75
                            earningId: 123
                            action: subscribe
                            type: promo
                            offerStart: '2025-01-01T00:00:00+00:00'
                            offerEnd: '2025-01-01T00:00:00+00:00'
                            isCurrent: true
                        hasActivePaidSubscriptions: true
                      canTrialSend: false
                      isBlocked: false
                      promoOffers: []
                      canUnsubscribe: true
                      isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000011
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49959
                properties:
                  data:
                    type: array
                    example:
                      -
                        view: x
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: Name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '23 days'
                        listsStates:
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: USER_NOT_PERFORMER
                          -
                            id: 1181087239
                            type: custom
                            name: 'Low Spenders-1PM'
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: rebill_off
                            type: rebill_off
                            name: 'Renew Off'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: rebill_on
                            type: rebill_on
                            name: 'Renew On'
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        canReport: true
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: false
                        isRealPerformer: false
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: '2025-01-01T00:00:00+00:00'
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '23 days'
                          showPostsInFeed: true
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 123
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 5
                          newPrice: 20
                          regularPrice: 5
                          subscribePrice: 5
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: '2025-01-01T00:00:00+00:00'
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '23 days'
                          tipsSumm: 0
                          subscribesSumm: 4
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 4
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                          subscribes:
                            -
                              id: 123
                              userId: 213
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 30
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 5
                              regularPrice: 20
                              discount: 75
                              earningId: 123
                              action: subscribe
                              type: promo
                              offerStart: '2025-01-01T00:00:00+00:00'
                              offerEnd: '2025-01-01T00:00:00+00:00'
                              isCurrent: true
                          hasActivePaidSubscriptions: true
                        canTrialSend: false
                        isBlocked: false
                        promoOffers: []
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    items:
                      type: object
                      properties:
                        view:
                          type: string
                          example: x
                        avatar:
                          type: string
                          example: null
                        avatarThumbs:
                          type: string
                          example: null
                        header:
                          type: string
                          example: null
                        headerSize:
                          type: string
                          example: null
                        headerThumbs:
                          type: string
                          example: null
                        id:
                          type: integer
                          example: 123
                        name:
                          type: string
                          example: Name
                        username:
                          type: string
                          example: username
                        canLookStory:
                          type: boolean
                          example: true
                        canCommentStory:
                          type: boolean
                          example: true
                        hasNotViewedStory:
                          type: boolean
                          example: false
                        isVerified:
                          type: boolean
                          example: false
                        canPayInternal:
                          type: boolean
                          example: true
                        hasScheduledStream:
                          type: boolean
                          example: false
                        hasStream:
                          type: boolean
                          example: false
                        hasStories:
                          type: boolean
                          example: false
                        tipsEnabled:
                          type: boolean
                          example: false
                        tipsTextEnabled:
                          type: boolean
                          example: true
                        tipsMin:
                          type: integer
                          example: 5
                        tipsMinInternal:
                          type: integer
                          example: 1
                        tipsMax:
                          type: integer
                          example: 200
                        canEarn:
                          type: boolean
                          example: false
                        canAddSubscriber:
                          type: boolean
                          example: false
                        subscribePrice:
                          type: integer
                          example: 0
                        displayName:
                          type: string
                          example: ''
                        notice:
                          type: string
                          example: ''
                        isRestricted:
                          type: boolean
                          example: false
                        canRestrict:
                          type: boolean
                          example: true
                        subscribedBy:
                          type: boolean
                          example: true
                        subscribedByExpire:
                          type: boolean
                          example: false
                        subscribedByExpireDate:
                          type: string
                          example: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong:
                          type: boolean
                          example: true
                        subscribedIsExpiredNow:
                          type: boolean
                          example: false
                        currentSubscribePrice:
                          type: integer
                          example: 0
                        subscribedOn:
                          type: boolean
                          example: true
                        subscribedOnExpiredNow:
                          type: boolean
                          example: false
                        subscribedOnDuration:
                          type: string
                          example: '23 days'
                        listsStates:
                          type: array
                          example:
                            -
                              id: fans
                              type: fans
                              name: Fans
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            -
                              id: following
                              type: following
                              name: Following
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            -
                              id: friends
                              type: friends
                              name: Friends
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: USER_NOT_PERFORMER
                            -
                              id: 1181087239
                              type: custom
                              name: 'Low Spenders-1PM'
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            -
                              id: muted
                              type: muted
                              name: Muted
                              hasUser: false
                              canAddUser: true
                              cannotAddUserReason: null
                            -
                              id: recent
                              type: recent
                              name: 'Recent (last 24 hours)'
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: SYSTEM_LIST
                            -
                              id: rebill_off
                              type: rebill_off
                              name: 'Renew Off'
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: null
                            -
                              id: rebill_on
                              type: rebill_on
                              name: 'Renew On'
                              hasUser: true
                              canAddUser: false
                              cannotAddUserReason: ALREADY_EXISTS
                            -
                              id: tagged
                              type: tagged
                              name: Tagged
                              hasUser: false
                              canAddUser: false
                              cannotAddUserReason: SYSTEM_LIST
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: fans
                              type:
                                type: string
                                example: fans
                              name:
                                type: string
                                example: Fans
                              hasUser:
                                type: boolean
                                example: true
                              canAddUser:
                                type: boolean
                                example: false
                              cannotAddUserReason:
                                type: string
                                example: ALREADY_EXISTS
                        canReport:
                          type: boolean
                          example: true
                        canReceiveChatMessage:
                          type: boolean
                          example: true
                        hideChat:
                          type: boolean
                          example: false
                        lastSeen:
                          type: string
                          example: '2025-01-01T00:00:00+00:00'
                        isPerformer:
                          type: boolean
                          example: false
                        isRealPerformer:
                          type: boolean
                          example: false
                        subscribedByData:
                          type: object
                          properties:
                            price:
                              type: integer
                              example: 0
                            newPrice:
                              type: integer
                              example: 0
                            regularPrice:
                              type: integer
                              example: 0
                            subscribePrice:
                              type: integer
                              example: 0
                            discountPercent:
                              type: integer
                              example: 0
                            discountPeriod:
                              type: integer
                              example: 1
                            subscribeAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            expiredAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            renewedAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            discountFinishedAt:
                              type: string
                              example: null
                            discountStartedAt:
                              type: string
                              example: null
                            status:
                              type: string
                              example: null
                            isMuted:
                              type: boolean
                              example: false
                            unsubscribeReason:
                              type: string
                              example: 'No reason given'
                            duration:
                              type: string
                              example: '23 days'
                            showPostsInFeed:
                              type: boolean
                              example: true
                            subscribes:
                              type: array
                              example:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 123
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  userId:
                                    type: integer
                                    example: 123
                                  subscriberId:
                                    type: integer
                                    example: 123
                                  date:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  duration:
                                    type: integer
                                    example: 123
                                  startDate:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  expireDate:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  cancelDate:
                                    type: string
                                    example: null
                                  price:
                                    type: integer
                                    example: 0
                                  regularPrice:
                                    type: integer
                                    example: 0
                                  discount:
                                    type: integer
                                    example: 0
                                  earningId:
                                    type: integer
                                    example: 0
                                  action:
                                    type: string
                                    example: subscribe
                                  type:
                                    type: string
                                    example: auto
                                  offerStart:
                                    type: string
                                    example: null
                                  offerEnd:
                                    type: string
                                    example: null
                                  isCurrent:
                                    type: boolean
                                    example: true
                            hasActivePaidSubscriptions:
                              type: boolean
                              example: false
                        subscribedOnData:
                          type: object
                          properties:
                            price:
                              type: integer
                              example: 5
                            newPrice:
                              type: integer
                              example: 20
                            regularPrice:
                              type: integer
                              example: 5
                            subscribePrice:
                              type: integer
                              example: 5
                            discountPercent:
                              type: integer
                              example: 0
                            discountPeriod:
                              type: integer
                              example: 1
                            subscribeAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            expiredAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            renewedAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            discountFinishedAt:
                              type: string
                              example: null
                            discountStartedAt:
                              type: string
                              example: null
                            status:
                              type: string
                              example: null
                            isMuted:
                              type: boolean
                              example: false
                            unsubscribeReason:
                              type: string
                              example: 'No reason given'
                            duration:
                              type: string
                              example: '23 days'
                            tipsSumm:
                              type: integer
                              example: 0
                            subscribesSumm:
                              type: integer
                              example: 4
                            messagesSumm:
                              type: integer
                              example: 0
                            postsSumm:
                              type: integer
                              example: 0
                            streamsSumm:
                              type: integer
                              example: 0
                            totalSumm:
                              type: integer
                              example: 4
                            lastActivity:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            recommendations:
                              type: integer
                              example: 0
                            subscribes:
                              type: array
                              example:
                                -
                                  id: 123
                                  userId: 213
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 30
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 5
                                  regularPrice: 20
                                  discount: 75
                                  earningId: 123
                                  action: subscribe
                                  type: promo
                                  offerStart: '2025-01-01T00:00:00+00:00'
                                  offerEnd: '2025-01-01T00:00:00+00:00'
                                  isCurrent: true
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  userId:
                                    type: integer
                                    example: 213
                                  subscriberId:
                                    type: integer
                                    example: 123
                                  date:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  duration:
                                    type: integer
                                    example: 30
                                  startDate:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  expireDate:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  cancelDate:
                                    type: string
                                    example: null
                                  price:
                                    type: integer
                                    example: 5
                                  regularPrice:
                                    type: integer
                                    example: 20
                                  discount:
                                    type: integer
                                    example: 75
                                  earningId:
                                    type: integer
                                    example: 123
                                  action:
                                    type: string
                                    example: subscribe
                                  type:
                                    type: string
                                    example: promo
                                  offerStart:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  offerEnd:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  isCurrent:
                                    type: boolean
                                    example: true
                            hasActivePaidSubscriptions:
                              type: boolean
                              example: true
                        canTrialSend:
                          type: boolean
                          example: false
                        isBlocked:
                          type: boolean
                          example: false
                        promoOffers:
                          type: array
                          example: []
                        canUnsubscribe:
                          type: boolean
                          example: true
                        isPendingAutoprolong:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000011
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49959
      tags:
        - Notifications
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/notifications/counts':
    get:
      summary: 'Get Notification Counts'
      operationId: getNotificationCounts
      description: 'Get a quick overview of all unread notification types'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    all: 123
                    subscribed: 123
                    purchases: 123
                    tip: 123
                    tags: 123
                    commented: 123
                    mentioned: 123
                    favorited: 123
                    message: 123
                    deactivated_media: 123
                    system: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000027
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      all:
                        type: integer
                        example: 123
                      subscribed:
                        type: integer
                        example: 123
                      purchases:
                        type: integer
                        example: 123
                      tip:
                        type: integer
                        example: 123
                      tags:
                        type: integer
                        example: 123
                      commented:
                        type: integer
                        example: 123
                      mentioned:
                        type: integer
                        example: 123
                      favorited:
                        type: integer
                        example: 123
                      message:
                        type: integer
                        example: 123
                      deactivated_media:
                        type: integer
                        example: 123
                      system:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000027
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - Notifications
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/notifications/mark-all-as-read':
    post:
      summary: 'Mark All Notifications As Read'
      operationId: markAllNotificationsAsRead
      description: 'Mark all notifications of this account as read'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000014
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49972
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000014
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49972
      tags:
        - Notifications
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/notifications/tabs-order':
    get:
      summary: 'Get Notification Tabs Order'
      operationId: getNotificationTabsOrder
      description: "Get the order of an account's notification tabs as displayed on the OnlyFans notifications page"
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    - all
                    - subscribed
                    - deactivated_media
                    - purchases
                    - tip
                    - tags
                    - commented
                    - mentioned
                    - favorited
                    - message
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000025
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49995
                properties:
                  data:
                    type: array
                    example:
                      - all
                      - subscribed
                      - deactivated_media
                      - purchases
                      - tip
                      - tags
                      - commented
                      - mentioned
                      - favorited
                      - message
                    items:
                      type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000025
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49995
      tags:
        - Notifications
    put:
      summary: 'Update Notification Tabs Order'
      operationId: updateNotificationTabsOrder
      description: "Update the order of an account's notification tabs as displayed on the OnlyFans notifications page"
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000000018
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999997
                      remaining_day: 49979
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000000018
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999997
                          remaining_day:
                            type: integer
                            example: 49979
      tags:
        - Notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tabs:
                  type: array
                  description: 'Array of tab keys. Must include exactly these: all, subscriptions, onlyfans, purchases, tips, tags, comments, mentions, likes, promotions.'
                  example:
                    - all
                    - subscriptions
                    - onlyfans
                    - purchases
                    - tips
                    - tags
                    - comments
                    - mentions
                    - likes
                    - promotions
                  items:
                    type: string
              required:
                - tabs
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/payouts/balances':
    get:
      summary: 'Get Account Balances'
      operationId: getAccountBalances
      description: 'Get the current available and pending balances for the account.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    payoutAvailable: 123.45
                    payoutPending: 123.45
                    currency: USD
                    minPayoutSumm: 20
                    maxPayoutSumm: 213.45
                    withdrawalPeriodOptions:
                      -
                        code: manual
                        name: 'Manual payouts'
                      -
                        code: weekly
                        name: 'Weekly payouts'
                      -
                        code: monthly
                        name: 'Monthly payouts'
                    manualPayoutPendingDays: 7
                    withdrawalPeriod: manual
                  _meta:
                    _credits:
                      used: 1
                      balance: 25661
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 5000
                      remaining_minute: 999
                      remaining_day: 4994
                properties:
                  data:
                    type: object
                    properties:
                      payoutAvailable:
                        type: number
                        example: 123.45
                      payoutPending:
                        type: number
                        example: 123.45
                      currency:
                        type: string
                        example: USD
                      minPayoutSumm:
                        type: integer
                        example: 20
                      maxPayoutSumm:
                        type: number
                        example: 213.45
                      withdrawalPeriodOptions:
                        type: array
                        example:
                          -
                            code: manual
                            name: 'Manual payouts'
                          -
                            code: weekly
                            name: 'Weekly payouts'
                          -
                            code: monthly
                            name: 'Monthly payouts'
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                              example: manual
                            name:
                              type: string
                              example: 'Manual payouts'
                      manualPayoutPendingDays:
                        type: integer
                        example: 7
                      withdrawalPeriod:
                        type: string
                        example: manual
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 25661
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 5000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 4994
      tags:
        - Payouts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/payouts/eligibility':
    get:
      summary: 'Get Eligibility'
      operationId: getEligibility
      description: 'Get the eligibility details for receiving payouts.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isVerifiedReason: false
                    canReceiveManualPayout: true
                    needUpdateBanking: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999846
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49850
                properties:
                  data:
                    type: object
                    properties:
                      isVerifiedReason:
                        type: boolean
                        example: false
                      canReceiveManualPayout:
                        type: boolean
                        example: true
                      needUpdateBanking:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999846
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49850
      tags:
        - Payouts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/payouts/transactions':
    get:
      summary: 'List Transactions (Earnings)'
      operationId: listTransactionsEarnings
      description: 'List all transactions for the account.'
      parameters:
        -
          in: query
          name: startDate
          description: 'Start date of the transactions.'
          example: 10
          required: false
          schema:
            type: string
            description: 'Start date of the transactions.'
            example: 10
        -
          in: query
          name: marker
          description: 'Current marker used for pagination. Provide UNIX timestamp or ISO 8601 string. Leave empty for current timestamp. Default: `null`'
          example: '1739155047'
          required: false
          schema:
            type: string
            description: 'Current marker used for pagination. Provide UNIX timestamp or ISO 8601 string. Leave empty for current timestamp. Default: `null`'
            example: '1739155047'
        -
          in: query
          name: limit
          description: 'How many transactions to show per page. Maximum `100`. Default: `10`'
          example: '10'
          required: false
          schema:
            type: string
            description: 'How many transactions to show per page. Maximum `100`. Default: `10`'
            example: '10'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        amount: 12.34
                        vatAmount: 12.34
                        taxAmount: 12.34
                        mediaTaxAmount: 12.34
                        net: 12.34
                        fee: 12.34
                        createdAt: '2025-01-01T01:01:01+00:00'
                        currency: USD
                        description: 'Subscription from <a href="https://onlyfans.com/username">Name</a>'
                        status: loading
                        user:
                          view: t
                          id: 123
                          name: Name
                          username: username
                          isVerified: false
                          avatar: null
                          avatarThumbs: null
                        payoutPendingDays: 7
                        id: abc123
                    marker: 123
                    hasMore: true
                    nextMarker: 1234
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999845
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49849
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            amount: 12.34
                            vatAmount: 12.34
                            taxAmount: 12.34
                            mediaTaxAmount: 12.34
                            net: 12.34
                            fee: 12.34
                            createdAt: '2025-01-01T01:01:01+00:00'
                            currency: USD
                            description: 'Subscription from <a href="https://onlyfans.com/username">Name</a>'
                            status: loading
                            user:
                              view: t
                              id: 123
                              name: Name
                              username: username
                              isVerified: false
                              avatar: null
                              avatarThumbs: null
                            payoutPendingDays: 7
                            id: abc123
                        items:
                          type: object
                          properties:
                            amount:
                              type: number
                              example: 12.34
                            vatAmount:
                              type: number
                              example: 12.34
                            taxAmount:
                              type: number
                              example: 12.34
                            mediaTaxAmount:
                              type: number
                              example: 12.34
                            net:
                              type: number
                              example: 12.34
                            fee:
                              type: number
                              example: 12.34
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            currency:
                              type: string
                              example: USD
                            description:
                              type: string
                              example: 'Subscription from <a href="https://onlyfans.com/username">Name</a>'
                            status:
                              type: string
                              example: loading
                            user:
                              type: object
                              properties:
                                view:
                                  type: string
                                  example: t
                                id:
                                  type: integer
                                  example: 123
                                name:
                                  type: string
                                  example: Name
                                username:
                                  type: string
                                  example: username
                                isVerified:
                                  type: boolean
                                  example: false
                                avatar:
                                  type: string
                                  example: null
                                avatarThumbs:
                                  type: string
                                  example: null
                            payoutPendingDays:
                              type: integer
                              example: 7
                            id:
                              type: string
                              example: abc123
                      marker:
                        type: integer
                        example: 123
                      hasMore:
                        type: boolean
                        example: true
                      nextMarker:
                        type: integer
                        example: 1234
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999845
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49849
      tags:
        - Payouts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/payouts/earning-statistics':
    get:
      summary: 'Get Earning Statistics'
      operationId: getEarningStatistics
      description: 'Get total and monthly time-series earning statistics for the account.'
      parameters:
        -
          in: query
          name: startDate
          description: 'The start date for earning statistics. Keep empty to get all earnings.'
          example: '2025-01-01 00:00:00, -30days'
          required: false
          schema:
            type: string
            description: 'The start date for earning statistics. Keep empty to get all earnings.'
            example: '2025-01-01 00:00:00, -30days'
            nullable: true
        -
          in: query
          name: endDate
          description: 'The end date for earning statistics. Keep empty to get all earnings.'
          example: '2025-01-01 00:00:00, +30days'
          required: false
          schema:
            type: string
            description: 'The end date for earning statistics. Keep empty to get all earnings.'
            example: '2025-01-01 00:00:00, +30days'
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      months:
                        '1735689661':
                          tips:
                            -
                              time: 1735689661
                              net: 4
                              gross: 5
                          total_net: 100
                          total_gross: 125
                          subscribes:
                            -
                              time: 1735689661
                              net: 16
                              gross: 20
                      total:
                        tips:
                          total_net: 123.45
                          total_gross: 123.45
                        all:
                          total_net: 123.45
                          total_gross: 123.45
                        subscribes:
                          total_net: 123.45
                          total_gross: 123.45
                        chat_messages:
                          total_net: 123.45
                          total_gross: 123.45
                        post:
                          total_net: 123.45
                          total_gross: 123.45
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999842
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49846
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: object
                        properties:
                          months:
                            type: object
                            properties:
                              1735689661:
                                type: object
                                properties:
                                  tips:
                                    type: array
                                    example:
                                      - { time: 1735689661, net: 4, gross: 5 }
                                    items:
                                      type: object
                                      properties: { time: { type: integer, example: 1735689661 }, net: { type: integer, example: 4 }, gross: { type: integer, example: 5 } }
                                  total_net:
                                    type: integer
                                    example: 100
                                  total_gross:
                                    type: integer
                                    example: 125
                                  subscribes:
                                    type: array
                                    example:
                                      - { time: 1735689661, net: 16, gross: 20 }
                                    items:
                                      type: object
                                      properties: { time: { type: integer, example: 1735689661 }, net: { type: integer, example: 16 }, gross: { type: integer, example: 20 } }
                          total:
                            type: object
                            properties:
                              tips:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                              all:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                              subscribes:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                              chat_messages:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                              post:
                                type: object
                                properties:
                                  total_net:
                                    type: number
                                    example: 123.45
                                  total_gross:
                                    type: number
                                    example: 123.45
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999842
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49846
      tags:
        - Payouts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/payouts/payout-requests':
    get:
      summary: 'List Payout Requests'
      operationId: listPayoutRequests
      description: 'List all payout requests for the account.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of payout requests to return'
          example: 10
          required: false
          schema:
            type: string
            description: 'Number of payout requests to return'
            example: 10
        -
          in: query
          name: offset
          description: 'Number of payout requests to skip for pagination'
          example: 0
          required: false
          schema:
            type: string
            description: 'Number of payout requests to skip for pagination'
            example: 0
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        invoiceId: '123'
                        createdAt: '2025-01-01T01:01:01+00:00'
                        amount: 123
                        currency: USD
                        state: new
                        rejectReason: null
                    marker: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999844
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49848
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            invoiceId: '123'
                            createdAt: '2025-01-01T01:01:01+00:00'
                            amount: 123
                            currency: USD
                            state: new
                            rejectReason: null
                        items:
                          type: object
                          properties:
                            invoiceId:
                              type: string
                              example: '123'
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            amount:
                              type: integer
                              example: 123
                            currency:
                              type: string
                              example: USD
                            state:
                              type: string
                              example: new
                            rejectReason:
                              type: string
                              example: null
                      marker:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999844
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49848
      tags:
        - Payouts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/payouts/payout-frequency':
    patch:
      summary: 'Update Payout Frequency'
      operationId: updatePayoutFrequency
      description: 'Update the payout frequency for the account (Manual, Weekly or Monthly).'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999871
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999994
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999871
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999994
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Payouts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                frequency:
                  type: string
                  description: 'The new payout frequency'
                  example: manual
                  enum:
                    - manual
                    - weekly
                    - monthly
              required:
                - frequency
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/payouts/request-manual-withdrawal':
    post:
      summary: 'Request Manual Withdrawal'
      operationId: requestManualWithdrawal
      description: 'Request a payout withdrawal, if the frequency is set to manual. Refer to our `/payouts/balances` endpoint to retrieve the minimum and maximum withdrawal amounts.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: ''
                    type: object
                    example:
                      data:
                        list:
                          -
                            state: new
                            rejectReason: null
                      _meta:
                        _credits:
                          used: 1
                          balance: 1000000028
                          note: Always
                        _cache:
                          is_cached: false
                          note: 'Cache disabled for this endpoint'
                        _rate_limits:
                          limit_minute: 10000000
                          limit_day: 50000
                          remaining_minute: 9999999
                          remaining_day: 49998
                    properties:
                      data:
                        type: object
                        properties:
                          list:
                            type: array
                            example:
                              -
                                state: new
                                rejectReason: null
                            items:
                              type: object
                              properties:
                                state:
                                  type: string
                                  example: new
                                rejectReason:
                                  type: string
                                  example: null
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 1000000028
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: 'Cache disabled for this endpoint'
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 10000000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 9999999
                              remaining_day:
                                type: integer
                                example: 49998
                  -
                    description: ''
                    type: object
                    example:
                      data:
                        list:
                          -
                            state: new
                            rejectReason: null
                      _meta:
                        _credits:
                          used: 1
                          balance: 1000000028
                          note: Always
                        _cache:
                          is_cached: false
                          note: 'Cache disabled for this endpoint'
                        _rate_limits:
                          limit_minute: 10000000
                          limit_day: 50000
                          remaining_minute: 9999999
                          remaining_day: 49998
                    properties:
                      data:
                        type: object
                        properties:
                          list:
                            type: array
                            example:
                              -
                                state: new
                                rejectReason: null
                            items:
                              type: object
                              properties:
                                state:
                                  type: string
                                  example: new
                                rejectReason:
                                  type: string
                                  example: null
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 1000000028
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: 'Cache disabled for this endpoint'
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 10000000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 9999999
                              remaining_day:
                                type: integer
                                example: 49998
        400:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: 'Not enough funds'
                    type: object
                    example:
                      error: ONLYFANS_COM_ERROR
                      message: 'Bad Request - The request could not be understood by the server.'
                      description: 'This error happened most probably because of a bug in the OnlyFans.com API or you sent wrong parameters (like a non-existing user id).'
                      onlyfans_response:
                        status: 400
                        body:
                          error:
                            code: 0
                            message: 'Not enough funds to request a payout'
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999866
                          note: 'OnlyFans returned an error, but we still had to make an API request to OnlyFans.com'
                        _cache:
                          is_cached: false
                          note: 'Cache disabled for this endpoint'
                        _rate_limits:
                          limit_minute: 10000000
                          limit_day: 50000
                          remaining_minute: 9999997
                          remaining_day: 49984
                    properties:
                      error:
                        type: string
                        example: ONLYFANS_COM_ERROR
                      message:
                        type: string
                        example: 'Bad Request - The request could not be understood by the server.'
                      description:
                        type: string
                        example: 'This error happened most probably because of a bug in the OnlyFans.com API or you sent wrong parameters (like a non-existing user id).'
                      onlyfans_response:
                        type: object
                        properties:
                          status:
                            type: integer
                            example: 400
                          body:
                            type: object
                            properties:
                              error:
                                type: object
                                properties:
                                  code:
                                    type: integer
                                    example: 0
                                  message:
                                    type: string
                                    example: 'Not enough funds to request a payout'
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999866
                              note:
                                type: string
                                example: 'OnlyFans returned an error, but we still had to make an API request to OnlyFans.com'
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: 'Cache disabled for this endpoint'
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 10000000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 9999997
                              remaining_day:
                                type: integer
                                example: 49984
                  -
                    description: 'Payout frequency is not set to manual'
                    type: object
                    example:
                      error: ONLYFANS_COM_ERROR
                      message: 'Bad Request - The request could not be understood by the server due to malformed syntax.'
                      description: 'This error happened most probably because of a bug in the OnlyFans.com API or you sent wrong parameters (like a non-existing user id).'
                      onlyfans_response:
                        status: 400
                        body:
                          error:
                            code: 0
                            message: 'Please contact support to resume payouts'
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999865
                          note: 'OnlyFans returned an error, but we still had to make an API request to OnlyFans.com'
                        _cache:
                          is_cached: false
                          note: 'Cache disabled for this endpoint'
                        _rate_limits:
                          limit_minute: 10000000
                          limit_day: 50000
                          remaining_minute: 9999996
                          remaining_day: 49983
                    properties:
                      error:
                        type: string
                        example: ONLYFANS_COM_ERROR
                      message:
                        type: string
                        example: 'Bad Request - The request could not be understood by the server due to malformed syntax.'
                      description:
                        type: string
                        example: 'This error happened most probably because of a bug in the OnlyFans.com API or you sent wrong parameters (like a non-existing user id).'
                      onlyfans_response:
                        type: object
                        properties:
                          status:
                            type: integer
                            example: 400
                          body:
                            type: object
                            properties:
                              error:
                                type: object
                                properties:
                                  code:
                                    type: integer
                                    example: 0
                                  message:
                                    type: string
                                    example: 'Please contact support to resume payouts'
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999865
                              note:
                                type: string
                                example: 'OnlyFans returned an error, but we still had to make an API request to OnlyFans.com'
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: 'Cache disabled for this endpoint'
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 10000000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 9999996
                              remaining_day:
                                type: integer
                                example: 49983
      tags:
        - Payouts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: integer
                  description: 'The amount to withdraw. Amount may not be higher than the current balance.'
                  example: 50
              required:
                - amount
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/posts/{post_id}/comments':
    get:
      summary: 'List Post Comments'
      operationId: listPostComments
      description: 'Get comments from one of your posts.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of comments to return (default = 10)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of comments to return (default = 10)'
            example: 10
        -
          in: query
          name: offset
          description: 'Number of comments to skip for pagination'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Number of comments to skip for pagination'
            example: 0
        -
          in: query
          name: sort
          description: 'Sort the returned comments (default = desc)'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort the returned comments (default = desc)'
            example: desc
            enum:
              - desc
              - asc
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        text: Text
                        giphyId: null
                        author:
                          id: 123
                          _view: s
                        canLike: true
                        likesCount: 0
                        isLiked: false
                        isLikedByAuthor: false
                        postedAt: '2025-01-01T00:00:00+00:00'
                        changedAt: '2025-01-01T00:00:00+00:00'
                        isPinned: false
                    hasMore: false
                    nextOffset: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999876
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49883
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            text: Text
                            giphyId: null
                            author:
                              id: 123
                              _view: s
                            canLike: true
                            likesCount: 0
                            isLiked: false
                            isLikedByAuthor: false
                            postedAt: '2025-01-01T00:00:00+00:00'
                            changedAt: '2025-01-01T00:00:00+00:00'
                            isPinned: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            text:
                              type: string
                              example: Text
                            giphyId:
                              type: string
                              example: null
                            author:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: s
                            canLike:
                              type: boolean
                              example: true
                            likesCount:
                              type: integer
                              example: 0
                            isLiked:
                              type: boolean
                              example: false
                            isLikedByAuthor:
                              type: boolean
                              example: false
                            postedAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            changedAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPinned:
                              type: boolean
                              example: false
                      hasMore:
                        type: boolean
                        example: false
                      nextOffset:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999876
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49883
      tags:
        - 'Post Comments'
    post:
      summary: 'Create Post Comment'
      operationId: createPostComment
      description: 'Create a comment on one of your posts.'
      parameters:
        -
          in: query
          name: text
          description: 'The text of the comment.'
          example: 'This is a comment.'
          required: true
          schema:
            type: string
            description: 'The text of the comment.'
            example: 'This is a comment.'
        -
          in: query
          name: answerTo
          description: 'The ID of the comment to which this comment is a reply.'
          example: 123
          required: false
          schema:
            type: integer
            description: 'The ID of the comment to which this comment is a reply.'
            example: 123
        -
          in: query
          name: giphyId
          description: 'The ID of the Giphy to include in the comment.'
          example: giphy123
          required: false
          schema:
            type: string
            description: 'The ID of the Giphy to include in the comment.'
            example: giphy123
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    text: Text
                    giphyId: null
                    author:
                      view: s
                      avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                      avatarThumbs:
                        c50: 'https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg'
                        c144: 'https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg'
                      header: 'https://public.onlyfans.com/files/.../header_image.jpg'
                      headerSize:
                        width: 4032
                        height: 3024
                      headerThumbs:
                        w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header_image.jpg'
                        w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header_image.jpg'
                      id: 123
                      name: Name
                      username: username
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: true
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: true
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: true
                      canAddSubscriber: false
                      subscribePrice: 4.99
                      hasStripe: false
                      isStripeExist: false
                      subscriptionBundles: []
                      canSendChatToAll: true
                      creditsMin: 10
                      creditsMax: 200
                      isPaywallPassed: true
                      creditsMinAlternatives: 5
                      canCreateLists: true
                      showMediaCount: true
                      lastSeen: '2025-01-01T00:00:00+00:00'
                      canReport: false
                      subscribedOn: null
                    canLike: true
                    likesCount: 0
                    isLiked: false
                    isLikedByAuthor: false
                    postedAt: '2025-01-01T00:00:00+00:00'
                    changedAt: '2025-01-01T00:00:00+00:00'
                    isPinned: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999852
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49857
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      text:
                        type: string
                        example: Text
                      giphyId:
                        type: string
                        example: null
                      author:
                        type: object
                        properties:
                          view:
                            type: string
                            example: s
                          avatar:
                            type: string
                            example: 'https://public.onlyfans.com/files/.../avatar.jpg'
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg'
                              c144:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg'
                          header:
                            type: string
                            example: 'https://public.onlyfans.com/files/.../header_image.jpg'
                          headerSize:
                            type: object
                            properties:
                              width:
                                type: integer
                                example: 4032
                              height:
                                type: integer
                                example: 3024
                          headerThumbs:
                            type: object
                            properties:
                              w480:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header_image.jpg'
                              w760:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header_image.jpg'
                          id:
                            type: integer
                            example: 123
                          name:
                            type: string
                            example: Name
                          username:
                            type: string
                            example: username
                          canLookStory:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          hasScheduledStream:
                            type: boolean
                            example: false
                          hasStream:
                            type: boolean
                            example: false
                          hasStories:
                            type: boolean
                            example: false
                          tipsEnabled:
                            type: boolean
                            example: true
                          tipsTextEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          canEarn:
                            type: boolean
                            example: true
                          canAddSubscriber:
                            type: boolean
                            example: false
                          subscribePrice:
                            type: number
                            example: 4.99
                          hasStripe:
                            type: boolean
                            example: false
                          isStripeExist:
                            type: boolean
                            example: false
                          subscriptionBundles:
                            type: array
                            example: []
                          canSendChatToAll:
                            type: boolean
                            example: true
                          creditsMin:
                            type: integer
                            example: 10
                          creditsMax:
                            type: integer
                            example: 200
                          isPaywallPassed:
                            type: boolean
                            example: true
                          creditsMinAlternatives:
                            type: integer
                            example: 5
                          canCreateLists:
                            type: boolean
                            example: true
                          showMediaCount:
                            type: boolean
                            example: true
                          lastSeen:
                            type: string
                            example: '2025-01-01T00:00:00+00:00'
                          canReport:
                            type: boolean
                            example: false
                          subscribedOn:
                            type: string
                            example: null
                      canLike:
                        type: boolean
                        example: true
                      likesCount:
                        type: integer
                        example: 0
                      isLiked:
                        type: boolean
                        example: false
                      isLikedByAuthor:
                        type: boolean
                        example: false
                      postedAt:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      changedAt:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      isPinned:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999852
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49857
      tags:
        - 'Post Comments'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post.'
        example: sapiente
        required: true
        schema:
          type: string
  '/api/{account}/posts/{post_id}/comments/{comment_id}':
    delete:
      summary: 'Delete Post Comment'
      operationId: deletePostComment
      description: 'Delete a comment on one of your posts.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999865
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49872
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999865
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49872
      tags:
        - 'Post Comments'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post to which the comment belongs.'
        example: 123
        required: true
        schema:
          type: integer
      -
        in: path
        name: comment_id
        description: 'The ID of the comment to delete.'
        example: 123
        required: true
        schema:
          type: integer
  '/api/{account}/posts/{post_id}/comments/{comment_id}/pin':
    post:
      summary: 'Pin Post Comment'
      operationId: pinPostComment
      description: 'Pin a comment on one of your posts.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999858
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49865
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999858
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49865
      tags:
        - 'Post Comments'
    delete:
      summary: 'Unpin Post Comment'
      operationId: unpinPostComment
      description: 'Unpin a comment from one of your posts.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999857
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49864
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999857
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49864
      tags:
        - 'Post Comments'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post to which the comment belongs.'
        example: 123
        required: true
        schema:
          type: integer
      -
        in: path
        name: comment_id
        description: 'The ID of the comment to pin.'
        example: 123
        required: true
        schema:
          type: integer
  '/api/{account}/posts/{post_id}/comments/{comment_id}/like':
    post:
      summary: 'Like Post Comment'
      operationId: likePostComment
      description: 'Like a comment on one of your posts.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    isLiked: true
                    likesCount: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999863
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 995
                      remaining_day: 49870
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      isLiked:
                        type: boolean
                        example: true
                      likesCount:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999863
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 995
                          remaining_day:
                            type: integer
                            example: 49870
      tags:
        - 'Post Comments'
    delete:
      summary: 'Unlike Post Comment'
      operationId: unlikePostComment
      description: 'Unlike a comment on one of your posts.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    isLiked: false
                    likesCount: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999862
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49869
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      isLiked:
                        type: boolean
                        example: false
                      likesCount:
                        type: integer
                        example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999862
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49869
      tags:
        - 'Post Comments'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post to which the comment belongs.'
        example: 123
        required: true
        schema:
          type: integer
      -
        in: path
        name: comment_id
        description: 'The ID of the comment to like.'
        example: 123
        required: true
        schema:
          type: integer
  '/api/{account}/posts/labels':
    get:
      summary: 'List Labels'
      operationId: listLabels
      description: 'List the labels that you can use to organize your posts.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of labels to return (default = 10)'
          example: 10
          required: false
          schema:
            type: string
            description: 'Number of labels to return (default = 10)'
            example: 10
        -
          in: query
          name: offset
          description: 'Number of labels to skip for pagination'
          example: 0
          required: false
          schema:
            type: string
            description: 'Number of labels to skip for pagination'
            example: 0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: archived
                        name: Archive
                        type: archived
                        isClearInProgress: false
                        postsCount: 0
                        posts: []
                      -
                        id: private_archived
                        name: 'Private Archive'
                        type: private_archived
                        isClearInProgress: false
                        postsCount: 0
                        posts: []
                      -
                        id: 123
                        name: 'My new label'
                        type: custom
                        isClearInProgress: false
                        postsCount: 123
                        posts: []
                    order: asc
                    sort: default
                    hasMore: false
                    nextOffset: 10
                    hashSort: abc123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999940
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: archived
                            name: Archive
                            type: archived
                            isClearInProgress: false
                            postsCount: 0
                            posts: []
                          -
                            id: private_archived
                            name: 'Private Archive'
                            type: private_archived
                            isClearInProgress: false
                            postsCount: 0
                            posts: []
                          -
                            id: 123
                            name: 'My new label'
                            type: custom
                            isClearInProgress: false
                            postsCount: 123
                            posts: []
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: archived
                            name:
                              type: string
                              example: Archive
                            type:
                              type: string
                              example: archived
                            isClearInProgress:
                              type: boolean
                              example: false
                            postsCount:
                              type: integer
                              example: 0
                            posts:
                              type: array
                              example: []
                      order:
                        type: string
                        example: asc
                      sort:
                        type: string
                        example: default
                      hasMore:
                        type: boolean
                        example: false
                      nextOffset:
                        type: integer
                        example: 10
                      hashSort:
                        type: string
                        example: abc123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999940
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - 'Post Labels'
    post:
      summary: 'Create Label'
      operationId: createLabel
      description: 'Create a new post label.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    name: 'My new label'
                    type: custom
                    isClearInProgress: false
                    postsCount: 0
                    posts: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999941
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: 'My new label'
                      type:
                        type: string
                        example: custom
                      isClearInProgress:
                        type: boolean
                        example: false
                      postsCount:
                        type: integer
                        example: 0
                      posts:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999941
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Post Labels'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'The name of your new label'
                  example: 'My new label'
              required:
                - name
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/posts':
    get:
      summary: 'List Posts'
      operationId: listPosts
      description: 'Get posts from your OnlyFans account.'
      parameters:
        -
          in: query
          name: query
          description: 'Search query to filter posts'
          example: Hello
          required: false
          schema:
            type: string
            description: 'Search query to filter posts'
            example: Hello
        -
          in: query
          name: limit
          description: 'Number of posts to return (default = 10)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of posts to return (default = 10)'
            example: 10
        -
          in: query
          name: offset
          description: 'Number of posts to skip for pagination'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Number of posts to skip for pagination'
            example: 0
        -
          in: query
          name: order
          description: 'Order the returned posts (default = publish_date)'
          example: publish_date
          required: false
          schema:
            type: string
            description: 'Order the returned posts (default = publish_date)'
            example: publish_date
            enum:
              - publish_date
              - favorites_count
              - tips_summ
        -
          in: query
          name: sort
          description: 'Sort the returned posts (default = desc)'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort the returned posts (default = desc)'
            example: desc
            enum:
              - desc
              - asc
        -
          in: query
          name: pinned
          description: 'Set to true to only show pinned posts'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Set to true to only show pinned posts'
            example: true
        -
          in: query
          name: counters
          description: 'Set to true to include an array of counters (see example responses)'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Set to true to include an array of counters (see example responses)'
            example: true
        -
          in: query
          name: minimumPublishDate
          description: 'Filter posts by minimum publish date'
          example: '2025-06-26'
          required: false
          schema:
            type: string
            description: 'Filter posts by minimum publish date'
            example: '2025-06-26'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        author:
                          id: 123
                          _view: a
                        responseType: post
                        id: 123
                        postedAt: '2025-01-01T01:01:01+00:00'
                        postedAtPrecise: '1234567890.000000'
                        text: '<p>Text</p>'
                        isMarkdownDisabled: true
                        canDelete: true
                        canComment: true
                        canEdit: true
                        isMediaReady: true
                        isOpened: true
                        canToggleFavorite: true
                        tipsAmount: $0
                        rawText: Text
                        canViewMedia: true
                    hasMore: false
                    headMarker: '1234567890.000000'
                    tailMarker: '1234567890.000000'
                    counters:
                      audiosCount: 123
                      photosCount: 123
                      videosCount: 123
                      mediasCount: 123
                      postsCount: 123
                      streamsCount: 123
                      archivedPostsCount: 123
                      privateArchivedPostsCount: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999886
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49896
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            author:
                              id: 123
                              _view: a
                            responseType: post
                            id: 123
                            postedAt: '2025-01-01T01:01:01+00:00'
                            postedAtPrecise: '1234567890.000000'
                            text: '<p>Text</p>'
                            isMarkdownDisabled: true
                            canDelete: true
                            canComment: true
                            canEdit: true
                            isMediaReady: true
                            isOpened: true
                            canToggleFavorite: true
                            tipsAmount: $0
                            rawText: Text
                            canViewMedia: true
                        items:
                          type: object
                          properties:
                            author:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                _view:
                                  type: string
                                  example: a
                            responseType:
                              type: string
                              example: post
                            id:
                              type: integer
                              example: 123
                            postedAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            postedAtPrecise:
                              type: string
                              example: '1234567890.000000'
                            text:
                              type: string
                              example: '<p>Text</p>'
                            isMarkdownDisabled:
                              type: boolean
                              example: true
                            canDelete:
                              type: boolean
                              example: true
                            canComment:
                              type: boolean
                              example: true
                            canEdit:
                              type: boolean
                              example: true
                            isMediaReady:
                              type: boolean
                              example: true
                            isOpened:
                              type: boolean
                              example: true
                            canToggleFavorite:
                              type: boolean
                              example: true
                            tipsAmount:
                              type: string
                              example: $0
                            rawText:
                              type: string
                              example: Text
                            canViewMedia:
                              type: boolean
                              example: true
                      hasMore:
                        type: boolean
                        example: false
                      headMarker:
                        type: string
                        example: '1234567890.000000'
                      tailMarker:
                        type: string
                        example: '1234567890.000000'
                      counters:
                        type: object
                        properties:
                          audiosCount:
                            type: integer
                            example: 123
                          photosCount:
                            type: integer
                            example: 123
                          videosCount:
                            type: integer
                            example: 123
                          mediasCount:
                            type: integer
                            example: 123
                          postsCount:
                            type: integer
                            example: 123
                          streamsCount:
                            type: integer
                            example: 123
                          archivedPostsCount:
                            type: integer
                            example: 123
                          privateArchivedPostsCount:
                            type: integer
                            example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999886
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49896
      tags:
        - Posts
    post:
      summary: 'Send Post'
      operationId: sendPost
      description: 'Compose and send a new post to your OnlyFans account.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    author:
                      view: a
                      avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                      avatarThumbs:
                        c50: 'https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg'
                        c144: 'https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg'
                      header: 'https://public.onlyfans.com/files/.../header_image.jpg'
                      headerSize:
                        width: 4032
                        height: 3024
                      headerThumbs:
                        w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header_image.jpg'
                        w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header_image.jpg'
                      id: 123
                      name: Name
                      username: username
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: true
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: false
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: true
                      canAddSubscriber: false
                      subscribePrice: 4.99
                      hasStripe: false
                      isStripeExist: false
                      subscriptionBundles: []
                      canSendChatToAll: true
                      creditsMin: 10
                      creditsMax: 200
                      isPaywallPassed: true
                      canCreateLists: true
                      showMediaCount: true
                      showPostsInFeed: true
                      subscribedBy: true
                      canTrialSend: false
                    responseType: post
                    id: 123
                    postedAt: '2025-01-01T01:01:01+00:00'
                    postedAtPrecise: '123.000000'
                    text: Text
                    isMarkdownDisabled: true
                    canDelete: true
                    canComment: true
                    canEdit: true
                    mediaCount: 1
                    isOpened: true
                    canToggleFavorite: true
                    tipsAmount: $0
                    rawText: Text
                    media:
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T00:00:00+00:00'
                        isReady: false
                        files:
                          full:
                            url: null
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 0
                        releaseForms: []
                        hasCustomPreview: false
                    canViewMedia: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999991
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      author:
                        type: object
                        properties:
                          view:
                            type: string
                            example: a
                          avatar:
                            type: string
                            example: 'https://public.onlyfans.com/files/.../avatar.jpg'
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg'
                              c144:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/.../avatar.jpg'
                          header:
                            type: string
                            example: 'https://public.onlyfans.com/files/.../header_image.jpg'
                          headerSize:
                            type: object
                            properties:
                              width:
                                type: integer
                                example: 4032
                              height:
                                type: integer
                                example: 3024
                          headerThumbs:
                            type: object
                            properties:
                              w480:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header_image.jpg'
                              w760:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header_image.jpg'
                          id:
                            type: integer
                            example: 123
                          name:
                            type: string
                            example: Name
                          username:
                            type: string
                            example: username
                          canLookStory:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          hasScheduledStream:
                            type: boolean
                            example: false
                          hasStream:
                            type: boolean
                            example: false
                          hasStories:
                            type: boolean
                            example: false
                          tipsEnabled:
                            type: boolean
                            example: false
                          tipsTextEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          canEarn:
                            type: boolean
                            example: true
                          canAddSubscriber:
                            type: boolean
                            example: false
                          subscribePrice:
                            type: number
                            example: 4.99
                          hasStripe:
                            type: boolean
                            example: false
                          isStripeExist:
                            type: boolean
                            example: false
                          subscriptionBundles:
                            type: array
                            example: []
                          canSendChatToAll:
                            type: boolean
                            example: true
                          creditsMin:
                            type: integer
                            example: 10
                          creditsMax:
                            type: integer
                            example: 200
                          isPaywallPassed:
                            type: boolean
                            example: true
                          canCreateLists:
                            type: boolean
                            example: true
                          showMediaCount:
                            type: boolean
                            example: true
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribedBy:
                            type: boolean
                            example: true
                          canTrialSend:
                            type: boolean
                            example: false
                      responseType:
                        type: string
                        example: post
                      id:
                        type: integer
                        example: 123
                      postedAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      postedAtPrecise:
                        type: string
                        example: '123.000000'
                      text:
                        type: string
                        example: Text
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      canComment:
                        type: boolean
                        example: true
                      canEdit:
                        type: boolean
                        example: true
                      mediaCount:
                        type: integer
                        example: 1
                      isOpened:
                        type: boolean
                        example: true
                      canToggleFavorite:
                        type: boolean
                        example: true
                      tipsAmount:
                        type: string
                        example: $0
                      rawText:
                        type: string
                        example: Text
                      media:
                        type: array
                        example:
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T00:00:00+00:00'
                            isReady: false
                            files:
                              full:
                                url: null
                                width: 0
                                height: 0
                                size: 0
                                sources: []
                              thumb: null
                              preview: null
                              squarePreview: null
                            duration: 0
                            releaseForms: []
                            hasCustomPreview: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: photo
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isReady:
                              type: boolean
                              example: false
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: null
                                    width:
                                      type: integer
                                      example: 0
                                    height:
                                      type: integer
                                      example: 0
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: string
                                  example: null
                                preview:
                                  type: string
                                  example: null
                                squarePreview:
                                  type: string
                                  example: null
                            duration:
                              type: integer
                              example: 0
                            releaseForms:
                              type: array
                              example: []
                            hasCustomPreview:
                              type: boolean
                              example: false
                      canViewMedia:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999991
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Posts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'The post text content'
                  example: Hello!
                labelIds:
                  type: string
                  description: 'Array of OF label IDs. Refer to our `/posts/labels` endpoint.'
                  example:
                    - 123
                mediaFiles:
                  type: array
                  description: 'Direct file uploads, OFAPI `ofapi_media_` IDs, or OF vault IDs.'
                  example:
                    - ofapi_media_abc123
                    - '1234567890'
                  items:
                    type: 'file[]|string'
                previews:
                  type: array
                  description: 'Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or integer indices referencing uploaded files in `mediaFiles`. Will be shown if `price` is provided.'
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: 'file[]|string[]|int'
                rfTag:
                  type: string
                  description: 'Array OnlyFans creator user IDs to tag in your post'
                  example:
                    - 123
                expireDays:
                  type: integer
                  description: 'Number of days after which the post will expire. Can be 1, 3, 7 or 30 days. Keep empty for no expiration.'
                  example: 3
                scheduledDate:
                  type: string
                  description: 'Schedule your post in the future (UTC timezone).'
                  example: '2025-01-01T00:00:00.000Z'
                saveForLater:
                  type: boolean
                  description: 'Add your post to the "Saved for later" queue.'
                  example: true
                fundRaisingTargetAmount:
                  type: integer
                  description: 'Add a fundraising target to your post. If present, value must be at least 10.'
                  example: 30
                fundRaisingTipsPresets:
                  type: array
                  description: 'Specify which tip amounts will be listed under the fundraising card. Required with `fundRaisingTargetAmount`, and you must provide at least 1 option. Array items cannot be higher than the `fundRaisingTargetAmount`.'
                  example:
                    - 5
                    - 10
                    - 15
                  items:
                    type: string
                votingType:
                  type: string
                  description: 'Include a poll or quiz within your post.'
                  example: poll
                  enum:
                    - poll
                    - quiz
                votingDue:
                  type: integer
                  description: 'The due date (in days) of your poll/quiz. Can be 1, 3, 7 or 30 days. Can only be filled with `votingType`.'
                  example: 3
                votingOptions:
                  type: array
                  description: 'The options of your poll/quiz. Required with `votingType`.'
                  example:
                    - 'First option'
                    - 'Second option'
                  items:
                    type: string
                votingCorrectIndex:
                  type: integer
                  description: 'The array key of your quiz'' correct answer. Required when `votingType` is "quiz". Keep in mind that arrays start at `0`'
                  example: 0
              required:
                - text
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/posts/{post_id}':
    get:
      summary: 'Get Post'
      operationId: getPost
      description: 'Retrieve details of a post from your account.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    author:
                      view: a
                      avatar: 'https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg'
                      avatarThumbs:
                        c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg'
                        c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg'
                      header: 'https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg'
                      headerSize:
                        width: 760
                        height: 570
                      headerThumbs:
                        w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg'
                        w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg'
                      id: 123
                      name: name
                      username: username
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: true
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: true
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: true
                      canAddSubscriber: false
                      subscribePrice: 0
                      hasStripe: false
                      isStripeExist: false
                      subscriptionBundles: []
                      canSendChatToAll: true
                      creditsMin: 10
                      creditsMax: 200
                      isPaywallPassed: true
                      canCreateLists: true
                      showMediaCount: true
                      showPostsInFeed: true
                      subscribedBy: true
                      canTrialSend: false
                    responseType: post
                    id: 123
                    postedAt: '2025-01-01T01:01:01+00:00'
                    postedAtPrecise: '123.000000'
                    text: '<p>Post text</p>'
                    isMarkdownDisabled: true
                    canDelete: true
                    canComment: true
                    canEdit: true
                    isMediaReady: true
                    isOpened: true
                    canToggleFavorite: true
                    canEditText: true
                    tipsAmount: $0
                    rawText: 'Post text'
                    canViewMedia: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999836
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      author:
                        type: object
                        properties:
                          view:
                            type: string
                            example: a
                          avatar:
                            type: string
                            example: 'https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg'
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg'
                              c144:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg'
                          header:
                            type: string
                            example: 'https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg'
                          headerSize:
                            type: object
                            properties:
                              width:
                                type: integer
                                example: 760
                              height:
                                type: integer
                                example: 570
                          headerThumbs:
                            type: object
                            properties:
                              w480:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg'
                              w760:
                                type: string
                                example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg'
                          id:
                            type: integer
                            example: 123
                          name:
                            type: string
                            example: name
                          username:
                            type: string
                            example: username
                          canLookStory:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          hasScheduledStream:
                            type: boolean
                            example: false
                          hasStream:
                            type: boolean
                            example: false
                          hasStories:
                            type: boolean
                            example: false
                          tipsEnabled:
                            type: boolean
                            example: true
                          tipsTextEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          canEarn:
                            type: boolean
                            example: true
                          canAddSubscriber:
                            type: boolean
                            example: false
                          subscribePrice:
                            type: integer
                            example: 0
                          hasStripe:
                            type: boolean
                            example: false
                          isStripeExist:
                            type: boolean
                            example: false
                          subscriptionBundles:
                            type: array
                            example: []
                          canSendChatToAll:
                            type: boolean
                            example: true
                          creditsMin:
                            type: integer
                            example: 10
                          creditsMax:
                            type: integer
                            example: 200
                          isPaywallPassed:
                            type: boolean
                            example: true
                          canCreateLists:
                            type: boolean
                            example: true
                          showMediaCount:
                            type: boolean
                            example: true
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribedBy:
                            type: boolean
                            example: true
                          canTrialSend:
                            type: boolean
                            example: false
                      responseType:
                        type: string
                        example: post
                      id:
                        type: integer
                        example: 123
                      postedAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      postedAtPrecise:
                        type: string
                        example: '123.000000'
                      text:
                        type: string
                        example: '<p>Post text</p>'
                      isMarkdownDisabled:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      canComment:
                        type: boolean
                        example: true
                      canEdit:
                        type: boolean
                        example: true
                      isMediaReady:
                        type: boolean
                        example: true
                      isOpened:
                        type: boolean
                        example: true
                      canToggleFavorite:
                        type: boolean
                        example: true
                      canEditText:
                        type: boolean
                        example: true
                      tipsAmount:
                        type: string
                        example: $0
                      rawText:
                        type: string
                        example: 'Post text'
                      canViewMedia:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999836
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Posts
    put:
      summary: 'Update Post'
      operationId: updatePost
      description: 'Update a posted, queued, or "saved for later" post.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - Posts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'The post text content'
                  example: Hello!
                labelIds:
                  type: string
                  description: 'Array of OF label IDs. Refer to our `/posts/labels` endpoint.'
                  example:
                    - 123
                price:
                  type: integer
                  description: 'Price for paid content (0 or between 3-100). In case this is not zero, **mediaFiles** is required'
                  example: 10
                mediaFiles:
                  type: string
                  description: 'Array of OFAPI `ofapi_media_` IDs, or OF media IDs'
                  example:
                    - ofapi_media_abc123
                    - '1234567890'
                rfTag:
                  type: string
                  description: 'Array OnlyFans creator user IDs to tag in your post'
                  example:
                    - 123
                expireDays:
                  type: integer
                  description: 'Number of days after which the post will expire. Can be 1, 3, 7 or 30 days. Keep empty for no expiration.'
                  example: 3
                scheduledDate:
                  type: string
                  description: 'Schedule your post in the future (UTC timezone).'
                  example: '2025-01-01T00:00:00.000Z'
                saveForLater:
                  type: boolean
                  description: 'Add your post to the "Saved for later" queue.'
                  example: true
                fundRaisingTargetAmount:
                  type: integer
                  description: 'Add a fundraising target to your post. If present, value must be at least 10.'
                  example: 30
                fundRaisingTipsPresets:
                  type: array
                  description: 'Specify which tip amounts will be listed under the fundraising card. Required with `fundRaisingTargetAmount`, and you must provide at least 1 option. Array items cannot be higher than the `fundRaisingTargetAmount`.'
                  example:
                    - 5
                    - 10
                    - 15
                  items:
                    type: string
                votingType:
                  type: string
                  description: 'Include a poll or quiz within your post.'
                  example: poll
                  enum:
                    - poll
                    - quiz
                votingDue:
                  type: integer
                  description: 'The due date (in days) of your poll/quiz. Can be 1, 3, 7 or 30 days. Can only be filled with `votingType`.'
                  example: 3
                votingOptions:
                  type: array
                  description: 'The options of your poll/quiz. Required with `votingType`.'
                  example:
                    - 'First option'
                    - 'Second option'
                  items:
                    type: string
                votingCorrectIndex:
                  type: integer
                  description: 'The array key of your quiz'' correct answer. Required when `votingType` is "quiz". Keep in mind that arrays start at `0`'
                  example: 0
              required:
                - text
    delete:
      summary: 'Delete Post'
      operationId: deletePost
      description: 'Delete a post from your account.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    counters:
                      audiosCount: 123
                      photosCount: 123
                      videosCount: 123
                      mediasCount: 123
                      postsCount: 123
                      streamsCount: 123
                      archivedPostsCount: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999989
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      counters:
                        type: object
                        properties:
                          audiosCount:
                            type: integer
                            example: 123
                          photosCount:
                            type: integer
                            example: 123
                          videosCount:
                            type: integer
                            example: 123
                          mediasCount:
                            type: integer
                            example: 123
                          postsCount:
                            type: integer
                            example: 123
                          streamsCount:
                            type: integer
                            example: 123
                          archivedPostsCount:
                            type: integer
                            example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999989
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Posts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/posts/{post_id}/archive':
    post:
      summary: 'Archive Post'
      operationId: archivePost
      description: 'Archive a post from your account. Also can be used to move posts between the Regular and Private Archive.'
      parameters:
        -
          in: query
          name: private_archive
          description: 'Set to `true` to move this post to the Private Archive.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Set to `true` to move this post to the Private Archive.'
            example: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    labelStates:
                      -
                        id: private_archived
                        name: 'Private Archive'
                        type: private_archived
                        isClearInProgress: false
                        postsCount: 0
                        posts: []
                      -
                        id: archived
                        name: Archive
                        type: archived
                        isClearInProgress: false
                        postsCount: 1
                        posts:
                          -
                            type: text
                            canViewMedia: true
                            postId: 1791158283
                    counters:
                      audiosCount: 0
                      photosCount: 0
                      videosCount: 0
                      mediasCount: 0
                      postsCount: 1
                      streamsCount: 0
                      archivedPostsCount: 1
                      privateArchivedPostsCount: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999901
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49917
                properties:
                  data:
                    type: object
                    properties:
                      labelStates:
                        type: array
                        example:
                          -
                            id: private_archived
                            name: 'Private Archive'
                            type: private_archived
                            isClearInProgress: false
                            postsCount: 0
                            posts: []
                          -
                            id: archived
                            name: Archive
                            type: archived
                            isClearInProgress: false
                            postsCount: 1
                            posts:
                              -
                                type: text
                                canViewMedia: true
                                postId: 1791158283
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: private_archived
                            name:
                              type: string
                              example: 'Private Archive'
                            type:
                              type: string
                              example: private_archived
                            isClearInProgress:
                              type: boolean
                              example: false
                            postsCount:
                              type: integer
                              example: 0
                            posts:
                              type: array
                              example: []
                      counters:
                        type: object
                        properties:
                          audiosCount:
                            type: integer
                            example: 0
                          photosCount:
                            type: integer
                            example: 0
                          videosCount:
                            type: integer
                            example: 0
                          mediasCount:
                            type: integer
                            example: 0
                          postsCount:
                            type: integer
                            example: 1
                          streamsCount:
                            type: integer
                            example: 0
                          archivedPostsCount:
                            type: integer
                            example: 1
                          privateArchivedPostsCount:
                            type: integer
                            example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999901
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49917
      tags:
        - Posts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/posts/{post_id}/unarchive':
    post:
      summary: 'Unarchive Post'
      operationId: unarchivePost
      description: 'Unarchive a post from your account.'
      parameters:
        -
          in: query
          name: private_archive
          description: 'Set to `true` if this post is currently in the Private Archive.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Set to `true` if this post is currently in the Private Archive.'
            example: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    labelStates:
                      -
                        id: archived
                        name: Archive
                        type: archived
                        isClearInProgress: false
                        postsCount: 0
                        posts: []
                    counters:
                      audiosCount: 0
                      photosCount: 0
                      videosCount: 0
                      mediasCount: 0
                      postsCount: 2
                      streamsCount: 0
                      archivedPostsCount: 0
                      privateArchivedPostsCount: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999903
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49919
                properties:
                  data:
                    type: object
                    properties:
                      labelStates:
                        type: array
                        example:
                          -
                            id: archived
                            name: Archive
                            type: archived
                            isClearInProgress: false
                            postsCount: 0
                            posts: []
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: archived
                            name:
                              type: string
                              example: Archive
                            type:
                              type: string
                              example: archived
                            isClearInProgress:
                              type: boolean
                              example: false
                            postsCount:
                              type: integer
                              example: 0
                            posts:
                              type: array
                              example: []
                      counters:
                        type: object
                        properties:
                          audiosCount:
                            type: integer
                            example: 0
                          photosCount:
                            type: integer
                            example: 0
                          videosCount:
                            type: integer
                            example: 0
                          mediasCount:
                            type: integer
                            example: 0
                          postsCount:
                            type: integer
                            example: 2
                          streamsCount:
                            type: integer
                            example: 0
                          archivedPostsCount:
                            type: integer
                            example: 0
                          privateArchivedPostsCount:
                            type: integer
                            example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999903
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49919
      tags:
        - Posts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/posts/{post_id}/pin':
    post:
      summary: 'Pin/Unpin Post'
      operationId: pinUnpinPost
      description: 'Pin or unpin a post to your account.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999883
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49892
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999883
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49892
      tags:
        - Posts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/posts/{post_id}/stats':
    get:
      summary: 'Show Post Statistics'
      operationId: showPostStatistics
      description: 'Show the statistics of a post like purchases, views, likes, tips and more.'
      parameters:
        -
          in: query
          name: with_historical_data
          description: 'Set to `true` to include historical data for a post.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Set to `true` to include historical data for a post.'
            example: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isAvailable: true
                    hasStats: false
                    hasVideo: false
                    lookCount: 0
                    uniqueLookCount: 0
                    uniqueLookChart:
                      -
                        date: '2025-06-20T19:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T20:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T21:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T22:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T23:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-21T00:00:00+00:00'
                        count: 0
                    lookChart:
                      -
                        date: '2025-06-20T19:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T20:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T21:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T22:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T23:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-21T00:00:00+00:00'
                        count: 0
                    lookDuration: 0
                    lookDurationAverage: 0
                    likeCount: 0
                    likeChart:
                      -
                        date: '2025-06-20T19:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T20:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T21:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T22:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T23:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-21T00:00:00+00:00'
                        count: 0
                    commentCount: 0
                    commentChart:
                      -
                        date: '2025-06-20T19:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T20:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T21:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T22:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T23:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-21T00:00:00+00:00'
                        count: 0
                    tipCount: 0
                    tipChart:
                      -
                        date: '2025-06-20T19:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T20:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T21:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T22:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T23:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-21T00:00:00+00:00'
                        count: 0
                    tipSum: 0
                    purchasedCount: 0
                    purchasedSumm: 0
                    tipSumChart:
                      -
                        date: '2025-06-20T19:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T20:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T21:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T22:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T23:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-21T00:00:00+00:00'
                        count: 0
                    purchasesChart:
                      -
                        date: '2025-06-20T19:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T20:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T21:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T22:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-20T23:00:00+00:00'
                        count: 0
                      -
                        date: '2025-06-21T00:00:00+00:00'
                        count: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999878
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49885
                properties:
                  data:
                    type: object
                    properties:
                      isAvailable:
                        type: boolean
                        example: true
                      hasStats:
                        type: boolean
                        example: false
                      hasVideo:
                        type: boolean
                        example: false
                      lookCount:
                        type: integer
                        example: 0
                      uniqueLookCount:
                        type: integer
                        example: 0
                      uniqueLookChart:
                        type: array
                        example:
                          -
                            date: '2025-06-20T19:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T20:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T21:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T22:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T23:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-21T00:00:00+00:00'
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-06-20T19:00:00+00:00'
                            count:
                              type: integer
                              example: 0
                      lookChart:
                        type: array
                        example:
                          -
                            date: '2025-06-20T19:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T20:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T21:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T22:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T23:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-21T00:00:00+00:00'
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-06-20T19:00:00+00:00'
                            count:
                              type: integer
                              example: 0
                      lookDuration:
                        type: integer
                        example: 0
                      lookDurationAverage:
                        type: integer
                        example: 0
                      likeCount:
                        type: integer
                        example: 0
                      likeChart:
                        type: array
                        example:
                          -
                            date: '2025-06-20T19:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T20:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T21:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T22:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T23:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-21T00:00:00+00:00'
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-06-20T19:00:00+00:00'
                            count:
                              type: integer
                              example: 0
                      commentCount:
                        type: integer
                        example: 0
                      commentChart:
                        type: array
                        example:
                          -
                            date: '2025-06-20T19:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T20:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T21:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T22:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T23:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-21T00:00:00+00:00'
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-06-20T19:00:00+00:00'
                            count:
                              type: integer
                              example: 0
                      tipCount:
                        type: integer
                        example: 0
                      tipChart:
                        type: array
                        example:
                          -
                            date: '2025-06-20T19:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T20:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T21:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T22:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T23:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-21T00:00:00+00:00'
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-06-20T19:00:00+00:00'
                            count:
                              type: integer
                              example: 0
                      tipSum:
                        type: integer
                        example: 0
                      purchasedCount:
                        type: integer
                        example: 0
                      purchasedSumm:
                        type: integer
                        example: 0
                      tipSumChart:
                        type: array
                        example:
                          -
                            date: '2025-06-20T19:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T20:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T21:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T22:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T23:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-21T00:00:00+00:00'
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-06-20T19:00:00+00:00'
                            count:
                              type: integer
                              example: 0
                      purchasesChart:
                        type: array
                        example:
                          -
                            date: '2025-06-20T19:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T20:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T21:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T22:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-20T23:00:00+00:00'
                            count: 0
                          -
                            date: '2025-06-21T00:00:00+00:00'
                            count: 0
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-06-20T19:00:00+00:00'
                            count:
                              type: integer
                              example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999878
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49885
      tags:
        - Posts
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: post_id
        description: 'The ID of the post'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/promotions':
    get:
      summary: 'List Promotions'
      operationId: listPromotions
      description: 'List all promotions for the account.'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of promotions to return. Default `10`'
          example: 10
          required: false
          schema:
            type: integer
            description: 'The number of promotions to return. Default `10`'
            example: 10
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: false
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: false
                    items:
                      -
                        id: 123
                        message: 'Example promotion message'
                        rawMessage: 'Example promotion message'
                        hasRelatedPromo: false
                        price: 0
                        type: all
                        canClaim: true
                        claimsCount: 0
                        subscribeCounts: 10
                        subscribeDays: 7
                        createdAt: '2025-01-01T00:00:00+00:00'
                        finishedAt: '2025-01-02T00:00:00+00:00'
                        isFinished: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999823
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: false
                      items:
                        type: array
                        example:
                          -
                            id: 123
                            message: 'Example promotion message'
                            rawMessage: 'Example promotion message'
                            hasRelatedPromo: false
                            price: 0
                            type: all
                            canClaim: true
                            claimsCount: 0
                            subscribeCounts: 10
                            subscribeDays: 7
                            createdAt: '2025-01-01T00:00:00+00:00'
                            finishedAt: '2025-01-02T00:00:00+00:00'
                            isFinished: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            message:
                              type: string
                              example: 'Example promotion message'
                            rawMessage:
                              type: string
                              example: 'Example promotion message'
                            hasRelatedPromo:
                              type: boolean
                              example: false
                            price:
                              type: integer
                              example: 0
                            type:
                              type: string
                              example: all
                            canClaim:
                              type: boolean
                              example: true
                            claimsCount:
                              type: integer
                              example: 0
                            subscribeCounts:
                              type: integer
                              example: 10
                            subscribeDays:
                              type: integer
                              example: 7
                            createdAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            finishedAt:
                              type: string
                              example: '2025-01-02T00:00:00+00:00'
                            isFinished:
                              type: boolean
                              example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999823
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Promotions
    post:
      summary: 'Create Promotion'
      operationId: createPromotion
      description: 'Create a new promotion for the account.'
      parameters:
        -
          in: query
          name: type
          description: 'Whether this promotion should apply to new subscribers, expired subscribers, or both. **IMPORTANT: when set to new_and_expired, the OF will create two separate promotions.**'
          example: new
          required: true
          schema:
            type: string
            description: 'Whether this promotion should apply to new subscribers, expired subscribers, or both. **IMPORTANT: when set to new_and_expired, the OF will create two separate promotions.**'
            example: new
            enum:
              - new
              - expired
              - new_and_expired
        -
          in: query
          name: discount
          description: "The discount percentage for the promotion's first month. Set to 100 to make this promotion a Free Trial."
          example: 10
          required: true
          schema:
            type: integer
            description: "The discount percentage for the promotion's first month. Set to 100 to make this promotion a Free Trial."
            example: 10
            enum:
              - 5
              - 10
              - 15
              - 20
              - 25
              - 30
              - 35
              - 40
              - 100
        -
          in: query
          name: offerLimit
          description: 'Limit how many people can claim this offer. Set to 0 for no limits.'
          example: 10
          required: true
          schema:
            type: integer
            description: 'Limit how many people can claim this offer. Set to 0 for no limits.'
            example: 10
            enum:
              - 0
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 20
              - 30
              - 40
              - 50
              - 60
              - 70
              - 80
              - 90
              - 100
        -
          in: query
          name: expirationDays
          description: 'In how many days this offer will expire. Set to 0 to make this promotion infinite.'
          example: 7
          required: true
          schema:
            type: integer
            description: 'In how many days this offer will expire. Set to 0 to make this promotion infinite.'
            example: 7
            enum:
              - 0
              - 1
              - 3
              - 7
              - 14
              - 30
        -
          in: query
          name: freeTrialDays
          description: 'Required only when discount is 100. Sets the duration (in days) of the free trial. Accepted 1-30'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Required only when discount is 100. Sets the duration (in days) of the free trial. Accepted 1-30'
            example: 10
        -
          in: query
          name: message
          description: 'Optionally, provide a message for this promotion.'
          example: 'Enjoy this special offer!'
          required: false
          schema:
            type: string
            description: 'Optionally, provide a message for this promotion.'
            example: 'Enjoy this special offer!'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 123
                      message: 'Example promotion message'
                      rawMessage: 'Example promotion message'
                      hasRelatedPromo: false
                      price: 0
                      type: all
                      canClaim: true
                      claimsCount: 0
                      subscribeCounts: 10
                      subscribeDays: 7
                      createdAt: '2025-01-01T00:00:00+00:00'
                      finishedAt: '2025-01-02T00:00:00+00:00'
                      isFinished: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999816
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 123
                        message: 'Example promotion message'
                        rawMessage: 'Example promotion message'
                        hasRelatedPromo: false
                        price: 0
                        type: all
                        canClaim: true
                        claimsCount: 0
                        subscribeCounts: 10
                        subscribeDays: 7
                        createdAt: '2025-01-01T00:00:00+00:00'
                        finishedAt: '2025-01-02T00:00:00+00:00'
                        isFinished: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        message:
                          type: string
                          example: 'Example promotion message'
                        rawMessage:
                          type: string
                          example: 'Example promotion message'
                        hasRelatedPromo:
                          type: boolean
                          example: false
                        price:
                          type: integer
                          example: 0
                        type:
                          type: string
                          example: all
                        canClaim:
                          type: boolean
                          example: true
                        claimsCount:
                          type: integer
                          example: 0
                        subscribeCounts:
                          type: integer
                          example: 10
                        subscribeDays:
                          type: integer
                          example: 7
                        createdAt:
                          type: string
                          example: '2025-01-01T00:00:00+00:00'
                        finishedAt:
                          type: string
                          example: '2025-01-02T00:00:00+00:00'
                        isFinished:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999816
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Promotions
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/promotions/{promotion_id}':
    delete:
      summary: 'Delete Promotion'
      operationId: deletePromotion
      description: 'Delete a promotion for the account.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999818
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999818
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Promotions
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: promotion_id
        description: 'The ID of the promotion to delete.'
        example: 123
        required: true
        schema:
          type: string
  '/api/{account}/promotions/{promotion_id}/stop':
    post:
      summary: 'Stop Promotion'
      operationId: stopPromotion
      description: 'Stop an active promotion for the account.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999819
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999819
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Promotions
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: promotion_id
        description: 'The ID of the promotion to stop.'
        example: 123
        required: true
        schema:
          type: string
  '/api/profiles/{username}':
    get:
      summary: 'Get Profile Details'
      operationId: getProfileDetails
      description: 'Get profile details by username.'
      parameters:
        -
          in: query
          name: fresh
          description: 'If `true` then OnlyFansAPI will always return the real time information about profile (eg. when was the profile last online).'
          example: true
          required: false
          schema:
            type: boolean
            description: 'If `true` then OnlyFansAPI will always return the real time information about profile (eg. when was the profile last online).'
            example: true
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ofapi_gender: female
                    ofapi_gender_confidence: 0.99
                    view: f
                    avatar: 'https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg'
                    header: 'https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg'
                    headerSize:
                      width: 760
                      height: 570
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg'
                    id: 123
                    name: name
                    username: username
                    canLookStory: false
                    canCommentStory: false
                    hasNotViewedStory: false
                    isVerified: true
                    canPayInternal: false
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: false
                    tipsEnabled: false
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 0
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: false
                    subscribedByExpire: null
                    subscribedByExpireDate: null
                    subscribedByAutoprolong: null
                    subscribedIsExpiredNow: null
                    currentSubscribePrice: null
                    subscribedOn: false
                    subscribedOnExpiredNow: null
                    subscribedOnDuration: null
                    joinDate: '2025-01-01T01:01:01+00:00'
                    isReferrerAllowed: true
                    about: ''
                    isMarkdownDisabledForAbout: true
                    website: 'https://onlyfans.com'
                    wishlist: null
                    location: null
                    postsCount: 2
                    archivedPostsCount: 0
                    privateArchivedPostsCount: 0
                    photosCount: 0
                    videosCount: 0
                    audiosCount: 0
                    mediasCount: 0
                    lastSeen: '2025-01-01T01:01:01+00:00'
                    favoritesCount: 0
                    favoritedCount: 0
                    showPostsInFeed: false
                    canReceiveChatMessage: false
                    isPerformer: true
                    isRealPerformer: false
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData: null
                    subscribedOnData: null
                    canCreatePromotion: false
                    canCreateTrial: false
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    referalBonusSummForReferer: 0
                    firstPublishedPostDate: '2025-01-01T01:01:01+00:00'
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999835
                      note: 'Cache MISS. We had to make a new request to OnlyFans.com because the cache expired'
                    _cache:
                      is_cached: false
                      note: 'Cache MISS. We had to make a new request to OnlyFans.com'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49993
                properties:
                  data:
                    type: object
                    properties:
                      ofapi_gender:
                        type: string
                        example: female
                      ofapi_gender_confidence:
                        type: number
                        example: 0.99
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/w/w6/w6g/.../123/avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/w/w6/w6g/.../123/avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/w/w6/w6g/.../123/avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/k/kk/kk6/.../123/header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 760
                          height:
                            type: integer
                            example: 570
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/k/kk/kk6/.../123/header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/k/kk/kk6/.../123/header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: false
                      canCommentStory:
                        type: boolean
                        example: false
                      hasNotViewedStory:
                        type: boolean
                        example: false
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: false
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: false
                      tipsEnabled:
                        type: boolean
                        example: false
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: integer
                        example: 0
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: false
                      subscribedByExpire:
                        type: string
                        example: null
                      subscribedByExpireDate:
                        type: string
                        example: null
                      subscribedByAutoprolong:
                        type: string
                        example: null
                      subscribedIsExpiredNow:
                        type: string
                        example: null
                      currentSubscribePrice:
                        type: string
                        example: null
                      subscribedOn:
                        type: boolean
                        example: false
                      subscribedOnExpiredNow:
                        type: string
                        example: null
                      subscribedOnDuration:
                        type: string
                        example: null
                      joinDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: ''
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: 'https://onlyfans.com'
                      wishlist:
                        type: string
                        example: null
                      location:
                        type: string
                        example: null
                      postsCount:
                        type: integer
                        example: 2
                      archivedPostsCount:
                        type: integer
                        example: 0
                      privateArchivedPostsCount:
                        type: integer
                        example: 0
                      photosCount:
                        type: integer
                        example: 0
                      videosCount:
                        type: integer
                        example: 0
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 0
                      lastSeen:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      favoritesCount:
                        type: integer
                        example: 0
                      favoritedCount:
                        type: integer
                        example: 0
                      showPostsInFeed:
                        type: boolean
                        example: false
                      canReceiveChatMessage:
                        type: boolean
                        example: false
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: false
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: string
                        example: null
                      subscribedOnData:
                        type: string
                        example: null
                      canCreatePromotion:
                        type: boolean
                        example: false
                      canCreateTrial:
                        type: boolean
                        example: false
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      referalBonusSummForReferer:
                        type: integer
                        example: 0
                      firstPublishedPostDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999835
                          note:
                            type: string
                            example: 'Cache MISS. We had to make a new request to OnlyFans.com because the cache expired'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache MISS. We had to make a new request to OnlyFans.com'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49993
      tags:
        - 'Public Profiles'
    parameters:
      -
        in: path
        name: username
        description: 'The username of the profile to get'
        example: madison420ivy
        required: true
        schema:
          type: string
  /api/search:
    get:
      summary: 'Search Profiles'
      operationId: searchProfiles
      description: 'Full-text search for profiles with filters for pricing, free trials, location, media count and more.'
      parameters:
        -
          in: query
          name: query
          description: 'Query for full text search in username, display name, bio. Must be at least 3 characters.'
          example: null
          required: false
          schema:
            type: string
            description: 'Query for full text search in username, display name, bio. Must be at least 3 characters.'
            example: null
        -
          in: query
          name: min_subscribe_price
          description: 'Filter by minimum subscribe price. Must be at least 0.00.'
          example: 0.0
          required: false
          schema:
            type: number
            description: 'Filter by minimum subscribe price. Must be at least 0.00.'
            example: 0.0
        -
          in: query
          name: max_subscribe_price
          description: 'Filter by maximum subscribe price. Must be at least 0.00.'
          example: 200.0
          required: false
          schema:
            type: number
            description: 'Filter by maximum subscribe price. Must be at least 0.00.'
            example: 200.0
        -
          in: query
          name: location
          description: 'Filter by location.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by location.'
            example: null
        -
          in: query
          name: website
          description: 'Filter by website.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by website.'
            example: null
        -
          in: query
          name: instagram
          description: 'Filter by Instagram username.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by Instagram username.'
            example: null
        -
          in: query
          name: tiktok
          description: 'Filter by TikTok username.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by TikTok username.'
            example: null
        -
          in: query
          name: limit
          description: 'The number of profiles to return. For each returned profile we charge your account 1 credit. Default: `10`. Must be at least 1. Must not be greater than 100.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'The number of profiles to return. For each returned profile we charge your account 1 credit. Default: `10`. Must be at least 1. Must not be greater than 100.'
            example: 10
        -
          in: query
          name: cursor
          description: 'Cursor for pagination. Use the `next_cursor` from the previous response to get the next page of results.'
          example: null
          required: false
          schema:
            type: string
            description: 'Cursor for pagination. Use the `next_cursor` from the previous response to get the next page of results.'
            example: null
            nullable: true
        -
          in: query
          name: sort
          description: 'Field to sort by. ⭐️ Only available on the Pro and Enterprise plan.'
          example: null
          required: false
          schema:
            type: string
            description: 'Field to sort by. ⭐️ Only available on the Pro and Enterprise plan.'
            example: null
            enum:
              - likes
              - photos
              - videos
              - subscribers
              - subscribe_price
              - min_subscribe_price
              - join_date
              - last_seen
        -
          in: query
          name: sortDirection
          description: 'Direction for sorting. `desc` - highest value first. `asc` - lowest value first.'
          example: null
          required: false
          schema:
            type: string
            description: 'Direction for sorting. `desc` - highest value first. `asc` - lowest value first.'
            example: null
            enum:
              - desc
              - asc
        -
          in: query
          name: filter
          description: ''
          example: []
          required: false
          schema:
            type: object
            description: ''
            example: []
            properties: {  }
        -
          in: query
          name: filter.gender
          description: 'Filter by gender (available: `female`, `male`, `trans`, `trans_ftm` (Female-to-Male), `trans_mft` (Male-to-Female), `couple`). ⭐️ Only available on the Pro and Enterprise plan.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter by gender (available: `female`, `male`, `trans`, `trans_ftm` (Female-to-Male), `trans_mft` (Male-to-Female), `couple`). ⭐️ Only available on the Pro and Enterprise plan.'
            example: null
            enum:
              - female
              - male
              - trans
              - trans_ftm
              - trans_mtf
              - couple
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ofapi_gender: female
                      ofapi_gender_confidence: 0.98
                      onlyfans_id: 5140520
                      stats_updated_at: '2025-12-15T21:00:42.000000Z'
                      username: madison420ivy
                      name: 'Madison Ivy'
                      avatar_url: 'https://public.onlyfans.com/files/v/v3/v30/v302xscgzgb1qijezrvsotwo4dxn00pe1760573833/5140520/avatar.jpg'
                      header_url: 'https://public.onlyfans.com/files/i/iz/izt/iztyiyvqu9mg54vccnxjjivnkz2cyivm1617484103/header.jpg'
                      subscribe_price: 0
                      min_subscribe_price: 0
                      posts_count: 157
                      photos_count: 530
                      videos_count: 207
                      audios_count: 0
                      favorites_count: 16
                      favorited_count: 570621
                      subscribers_count: null
                      is_verified: true
                      website: Www.fleshlight.com/Madisonivy
                      location: CannaBliss
                      wishlist: null
                      about: '<p>My wish in life is to be your personal lil fuck toy. WELCOME to my naughty corner of the world. <br /> I hope you’ll love my extremely up-close and personal POVs. I want to give you a true feeling of being with me. <br /> Let me tease you and please you.<br /> Command me, Master. For I am your little pet. <br /> And I am waiting… 😈💦<br /><br /> I absolutely love suggestions, so please feel free to send me a DM with ideas! I always try to include as much as possibles 💋<br /> 🚨Also about my page 👇👇👇👇👇👇👇👇<br /><br /> ...............................................................................................<br /> 💖 Custom Video Contest is returning soon!!!<br /> (Watch page for details)<br /> 💙Tipping is NEVER required. <br /> (But because my page is free, I’m starting to only respond to messages with tips. I’m very sorry about this, but for the past 5 years I’ve answered every single message. And they’re just isn’t enough time in the day.)  <br /> Xoxo<br />     Ur little fuck toy,<br />           </p>'
                      last_seen_at: null
                      is_performer: true
                      is_real_performer: true
                      is_adult_content: false
                      bundles: null
                      instagram: null
                      twitter: null
                      tiktok: null
                      facebook: null
                      promotions: null
                      join_date: '2018-11-11T00:00:00.000000Z'
                      fansly: null
                      pornhub: null
                      manyvids: null
                    -
                      ofapi_gender: male
                      ofapi_gender_confidence: 0.95
                      onlyfans_id: 117183
                      stats_updated_at: '2025-12-15T21:59:51.000000Z'
                      username: johnnysins
                      name: 'Johnny Sins'
                      avatar_url: 'https://public.onlyfans.com/files/e/ex/exf/exflcllrevoeqnhfeccma55z5desn4ct1686490893/117183/avatar.jpg'
                      header_url: null
                      subscribe_price: 0
                      min_subscribe_price: 0
                      posts_count: 9431
                      photos_count: 57499
                      videos_count: 14116
                      audios_count: 1
                      favorites_count: 72
                      favorited_count: 250727
                      subscribers_count: 202344
                      is_verified: true
                      website: 'https://Onlyfans.com/solojohnny'
                      location: null
                      wishlist: null
                      about: '<p>THE ONLY OFFICIAL JOHNNY SINS ONLYFANS<br /><br /> 🔥 NEW SUBSCRIBERS GET A FREE VIDEO FOR JOINING!!!<br /> 🔥 NEW scenes 2x per week!! </p>'
                      last_seen_at: '2025-12-15T21:01:35.000000Z'
                      is_performer: true
                      is_real_performer: true
                      is_adult_content: true
                      bundles: null
                      instagram: Mosttalentedbaldman
                      twitter: johnnysins
                      tiktok: Johnnysins
                      facebook: null
                      promotions: null
                      join_date: '2017-01-25T00:00:00.000000Z'
                      fansly: null
                      pornhub: null
                      manyvids: null
                  _pagination:
                    total_results: 10000
                    next_cursor: WzEsIjEwIl0=
                    next_page_url: 'https://app.onlyfansapi.com/api/search?limit=50&cursor=WzEsIjEwIl0%3D'
                  _meta:
                    _credits:
                      used: 1
                      balance: 115530
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49998
                properties:
                  data:
                    type: array
                    example:
                      -
                        ofapi_gender: female
                        ofapi_gender_confidence: 0.98
                        onlyfans_id: 5140520
                        stats_updated_at: '2025-12-15T21:00:42.000000Z'
                        username: madison420ivy
                        name: 'Madison Ivy'
                        avatar_url: 'https://public.onlyfans.com/files/v/v3/v30/v302xscgzgb1qijezrvsotwo4dxn00pe1760573833/5140520/avatar.jpg'
                        header_url: 'https://public.onlyfans.com/files/i/iz/izt/iztyiyvqu9mg54vccnxjjivnkz2cyivm1617484103/header.jpg'
                        subscribe_price: 0
                        min_subscribe_price: 0
                        posts_count: 157
                        photos_count: 530
                        videos_count: 207
                        audios_count: 0
                        favorites_count: 16
                        favorited_count: 570621
                        subscribers_count: null
                        is_verified: true
                        website: Www.fleshlight.com/Madisonivy
                        location: CannaBliss
                        wishlist: null
                        about: '<p>My wish in life is to be your personal lil fuck toy. WELCOME to my naughty corner of the world. <br /> I hope you’ll love my extremely up-close and personal POVs. I want to give you a true feeling of being with me. <br /> Let me tease you and please you.<br /> Command me, Master. For I am your little pet. <br /> And I am waiting… 😈💦<br /><br /> I absolutely love suggestions, so please feel free to send me a DM with ideas! I always try to include as much as possibles 💋<br /> 🚨Also about my page 👇👇👇👇👇👇👇👇<br /><br /> ...............................................................................................<br /> 💖 Custom Video Contest is returning soon!!!<br /> (Watch page for details)<br /> 💙Tipping is NEVER required. <br /> (But because my page is free, I’m starting to only respond to messages with tips. I’m very sorry about this, but for the past 5 years I’ve answered every single message. And they’re just isn’t enough time in the day.)  <br /> Xoxo<br />     Ur little fuck toy,<br />           </p>'
                        last_seen_at: null
                        is_performer: true
                        is_real_performer: true
                        is_adult_content: false
                        bundles: null
                        instagram: null
                        twitter: null
                        tiktok: null
                        facebook: null
                        promotions: null
                        join_date: '2018-11-11T00:00:00.000000Z'
                        fansly: null
                        pornhub: null
                        manyvids: null
                      -
                        ofapi_gender: male
                        ofapi_gender_confidence: 0.95
                        onlyfans_id: 117183
                        stats_updated_at: '2025-12-15T21:59:51.000000Z'
                        username: johnnysins
                        name: 'Johnny Sins'
                        avatar_url: 'https://public.onlyfans.com/files/e/ex/exf/exflcllrevoeqnhfeccma55z5desn4ct1686490893/117183/avatar.jpg'
                        header_url: null
                        subscribe_price: 0
                        min_subscribe_price: 0
                        posts_count: 9431
                        photos_count: 57499
                        videos_count: 14116
                        audios_count: 1
                        favorites_count: 72
                        favorited_count: 250727
                        subscribers_count: 202344
                        is_verified: true
                        website: 'https://Onlyfans.com/solojohnny'
                        location: null
                        wishlist: null
                        about: '<p>THE ONLY OFFICIAL JOHNNY SINS ONLYFANS<br /><br /> 🔥 NEW SUBSCRIBERS GET A FREE VIDEO FOR JOINING!!!<br /> 🔥 NEW scenes 2x per week!! </p>'
                        last_seen_at: '2025-12-15T21:01:35.000000Z'
                        is_performer: true
                        is_real_performer: true
                        is_adult_content: true
                        bundles: null
                        instagram: Mosttalentedbaldman
                        twitter: johnnysins
                        tiktok: Johnnysins
                        facebook: null
                        promotions: null
                        join_date: '2017-01-25T00:00:00.000000Z'
                        fansly: null
                        pornhub: null
                        manyvids: null
                    items:
                      type: object
                      properties:
                        ofapi_gender:
                          type: string
                          example: female
                        ofapi_gender_confidence:
                          type: number
                          example: 0.98
                        onlyfans_id:
                          type: integer
                          example: 5140520
                        stats_updated_at:
                          type: string
                          example: '2025-12-15T21:00:42.000000Z'
                        username:
                          type: string
                          example: madison420ivy
                        name:
                          type: string
                          example: 'Madison Ivy'
                        avatar_url:
                          type: string
                          example: 'https://public.onlyfans.com/files/v/v3/v30/v302xscgzgb1qijezrvsotwo4dxn00pe1760573833/5140520/avatar.jpg'
                        header_url:
                          type: string
                          example: 'https://public.onlyfans.com/files/i/iz/izt/iztyiyvqu9mg54vccnxjjivnkz2cyivm1617484103/header.jpg'
                        subscribe_price:
                          type: integer
                          example: 0
                        min_subscribe_price:
                          type: integer
                          example: 0
                        posts_count:
                          type: integer
                          example: 157
                        photos_count:
                          type: integer
                          example: 530
                        videos_count:
                          type: integer
                          example: 207
                        audios_count:
                          type: integer
                          example: 0
                        favorites_count:
                          type: integer
                          example: 16
                        favorited_count:
                          type: integer
                          example: 570621
                        subscribers_count:
                          type: string
                          example: null
                        is_verified:
                          type: boolean
                          example: true
                        website:
                          type: string
                          example: Www.fleshlight.com/Madisonivy
                        location:
                          type: string
                          example: CannaBliss
                        wishlist:
                          type: string
                          example: null
                        about:
                          type: string
                          example: '<p>My wish in life is to be your personal lil fuck toy. WELCOME to my naughty corner of the world. <br /> I hope you’ll love my extremely up-close and personal POVs. I want to give you a true feeling of being with me. <br /> Let me tease you and please you.<br /> Command me, Master. For I am your little pet. <br /> And I am waiting… 😈💦<br /><br /> I absolutely love suggestions, so please feel free to send me a DM with ideas! I always try to include as much as possibles 💋<br /> 🚨Also about my page 👇👇👇👇👇👇👇👇<br /><br /> ...............................................................................................<br /> 💖 Custom Video Contest is returning soon!!!<br /> (Watch page for details)<br /> 💙Tipping is NEVER required. <br /> (But because my page is free, I’m starting to only respond to messages with tips. I’m very sorry about this, but for the past 5 years I’ve answered every single message. And they’re just isn’t enough time in the day.)  <br /> Xoxo<br />     Ur little fuck toy,<br />           </p>'
                        last_seen_at:
                          type: string
                          example: null
                        is_performer:
                          type: boolean
                          example: true
                        is_real_performer:
                          type: boolean
                          example: true
                        is_adult_content:
                          type: boolean
                          example: false
                        bundles:
                          type: string
                          example: null
                        instagram:
                          type: string
                          example: null
                        twitter:
                          type: string
                          example: null
                        tiktok:
                          type: string
                          example: null
                        facebook:
                          type: string
                          example: null
                        promotions:
                          type: string
                          example: null
                        join_date:
                          type: string
                          example: '2018-11-11T00:00:00.000000Z'
                        fansly:
                          type: string
                          example: null
                        pornhub:
                          type: string
                          example: null
                        manyvids:
                          type: string
                          example: null
                  _pagination:
                    type: object
                    properties:
                      total_results:
                        type: integer
                        example: 10000
                      next_cursor:
                        type: string
                        example: WzEsIjEwIl0=
                      next_page_url:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/search?limit=50&cursor=WzEsIjEwIl0%3D'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 115530
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - 'Public Profiles'
  '/api/{account}/queue':
    get:
      summary: 'List Queue Items'
      operationId: listQueueItems
      description: 'List posts and messages in the queue.'
      parameters:
        -
          in: query
          name: publishDateStart
          description: 'Earliest publish date to return (must be at least today)'
          example: '2025-01-01'
          required: true
          schema:
            type: string
            description: 'Earliest publish date to return (must be at least today)'
            example: '2025-01-01'
        -
          in: query
          name: publishDateEnd
          description: 'Latest publish date to return'
          example: '2025-01-01'
          required: true
          schema:
            type: string
            description: 'Latest publish date to return'
            example: '2025-01-01'
        -
          in: query
          name: timezone
          description: 'Time timezone of the provided dates. [View available timezone values](https://www.php.net/manual/en/timezones.php)'
          example: Europe/Prague
          required: true
          schema:
            type: string
            description: 'Time timezone of the provided dates. [View available timezone values](https://www.php.net/manual/en/timezones.php)'
            example: Europe/Prague
        -
          in: query
          name: limit
          description: 'Maximum number of queue items to return (default = 20)'
          example: 20
          required: true
          schema:
            type: integer
            description: 'Maximum number of queue items to return (default = 20)'
            example: 20
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        type: chat
                        publishDateTime: '2025-01-01T01:01:01+01:01'
                        createdDateTime: '2025-01-01T01:01:01+01:01'
                        entity:
                          responseType: message
                          id: 123
                          text: '<p>Text</p>'
                          rawText: Text
                          giphyId: null
                          lockedText: false
                          isNew: true
                          isFree: true
                          isOpened: false
                          price: 0
                          isMediaReady: true
                          mediaCount: 0
                          media: []
                          previews: []
                          createdAt: '2025-01-01T01:01:01+01:01'
                          changedAt: '2025-01-01T01:01:01+01:01'
                          scheduledAt: '2025-01-01T01:01:01+01:01'
                          isTip: false
                          cancelSeconds: 1000000
                          isLiked: false
                          canPurchase: false
                          isMarkdownDisabled: true
                          releaseForms: []
                          userLists:
                            - fans
                          sentRulesType: list
                          sentRulesExtra: Fans
                          isFromQueue: true
                          queueId: 123
                          canUnsendQueue: true
                          unsendSecondsQueue: 1000000
                      -
                        id: 123
                        type: post
                        publishDateTime: '2025-01-01T01:01:01+01:01'
                        createdDateTime: '2025-01-01T01:01:01+01:01'
                        entity:
                          responseType: post
                          id: 123
                          postedAt: '2025-01-01T01:01:01+01:01'
                          postedAtPrecise: '1234567890.000000'
                          text: Text
                          isMarkdownDisabled: true
                          canDelete: true
                          canEdit: true
                          isMediaReady: true
                          isOpened: true
                          canToggleFavorite: true
                          tipsAmount: $0
                          rawText: Text
                          canViewMedia: true
                    syncInProcess: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999953
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            type: chat
                            publishDateTime: '2025-01-01T01:01:01+01:01'
                            createdDateTime: '2025-01-01T01:01:01+01:01'
                            entity:
                              responseType: message
                              id: 123
                              text: '<p>Text</p>'
                              rawText: Text
                              giphyId: null
                              lockedText: false
                              isNew: true
                              isFree: true
                              isOpened: false
                              price: 0
                              isMediaReady: true
                              mediaCount: 0
                              media: []
                              previews: []
                              createdAt: '2025-01-01T01:01:01+01:01'
                              changedAt: '2025-01-01T01:01:01+01:01'
                              scheduledAt: '2025-01-01T01:01:01+01:01'
                              isTip: false
                              cancelSeconds: 1000000
                              isLiked: false
                              canPurchase: false
                              isMarkdownDisabled: true
                              releaseForms: []
                              userLists:
                                - fans
                              sentRulesType: list
                              sentRulesExtra: Fans
                              isFromQueue: true
                              queueId: 123
                              canUnsendQueue: true
                              unsendSecondsQueue: 1000000
                          -
                            id: 123
                            type: post
                            publishDateTime: '2025-01-01T01:01:01+01:01'
                            createdDateTime: '2025-01-01T01:01:01+01:01'
                            entity:
                              responseType: post
                              id: 123
                              postedAt: '2025-01-01T01:01:01+01:01'
                              postedAtPrecise: '1234567890.000000'
                              text: Text
                              isMarkdownDisabled: true
                              canDelete: true
                              canEdit: true
                              isMediaReady: true
                              isOpened: true
                              canToggleFavorite: true
                              tipsAmount: $0
                              rawText: Text
                              canViewMedia: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: chat
                            publishDateTime:
                              type: string
                              example: '2025-01-01T01:01:01+01:01'
                            createdDateTime:
                              type: string
                              example: '2025-01-01T01:01:01+01:01'
                            entity:
                              type: object
                              properties:
                                responseType:
                                  type: string
                                  example: message
                                id:
                                  type: integer
                                  example: 123
                                text:
                                  type: string
                                  example: '<p>Text</p>'
                                rawText:
                                  type: string
                                  example: Text
                                giphyId:
                                  type: string
                                  example: null
                                lockedText:
                                  type: boolean
                                  example: false
                                isNew:
                                  type: boolean
                                  example: true
                                isFree:
                                  type: boolean
                                  example: true
                                isOpened:
                                  type: boolean
                                  example: false
                                price:
                                  type: integer
                                  example: 0
                                isMediaReady:
                                  type: boolean
                                  example: true
                                mediaCount:
                                  type: integer
                                  example: 0
                                media:
                                  type: array
                                  example: []
                                previews:
                                  type: array
                                  example: []
                                createdAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+01:01'
                                changedAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+01:01'
                                scheduledAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+01:01'
                                isTip:
                                  type: boolean
                                  example: false
                                cancelSeconds:
                                  type: integer
                                  example: 1000000
                                isLiked:
                                  type: boolean
                                  example: false
                                canPurchase:
                                  type: boolean
                                  example: false
                                isMarkdownDisabled:
                                  type: boolean
                                  example: true
                                releaseForms:
                                  type: array
                                  example: []
                                userLists:
                                  type: array
                                  example:
                                    - fans
                                  items:
                                    type: string
                                sentRulesType:
                                  type: string
                                  example: list
                                sentRulesExtra:
                                  type: string
                                  example: Fans
                                isFromQueue:
                                  type: boolean
                                  example: true
                                queueId:
                                  type: integer
                                  example: 123
                                canUnsendQueue:
                                  type: boolean
                                  example: true
                                unsendSecondsQueue:
                                  type: integer
                                  example: 1000000
                      syncInProcess:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999953
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - Queue
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/queue/{queue_id}/publish':
    put:
      summary: 'Publish Queue Item'
      operationId: publishQueueItem
      description: 'Publish a queue item or "saved for later" item (post or mass message). This means that the item will be sent immediately, regardless of its scheduled date.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999916
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49937
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999916
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49937
      tags:
        - Queue
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: queue_id
        description: 'The ID of the message queue item. Can be retrieved from Queue or Mass Messaging endpoints'
        example: 1234567890
        required: true
        schema:
          type: string
  '/api/{account}/queue/counts':
    get:
      summary: 'Count Queue Items'
      operationId: countQueueItems
      description: 'Count posts and messages in the queue.'
      parameters:
        -
          in: query
          name: publishDateStart
          description: 'Earliest publish date to count from (must be at least today)'
          example: '2025-01-01'
          required: true
          schema:
            type: string
            description: 'Earliest publish date to count from (must be at least today)'
            example: '2025-01-01'
        -
          in: query
          name: publishDateEnd
          description: 'Latest publish date to count to'
          example: '2025-01-01'
          required: true
          schema:
            type: string
            description: 'Latest publish date to count to'
            example: '2025-01-01'
        -
          in: query
          name: timezone
          description: 'Time timezone of the provided dates. [View available timezone values](https://www.php.net/manual/en/timezones.php)'
          example: Europe/Prague
          required: true
          schema:
            type: string
            description: 'Time timezone of the provided dates. [View available timezone values](https://www.php.net/manual/en/timezones.php)'
            example: Europe/Prague
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      '2025-01-01':
                        post: 2
                      '2025-01-02':
                        post: 3
                        chat: 4
                    syncInProcess: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999950
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49985
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: object
                        properties:
                          '2025-01-01':
                            type: object
                            properties:
                              post:
                                type: integer
                                example: 2
                          '2025-01-02':
                            type: object
                            properties:
                              post:
                                type: integer
                                example: 3
                              chat:
                                type: integer
                                example: 4
                      syncInProcess:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999950
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49985
      tags:
        - Queue
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/release-forms/taggable-users':
    get:
      summary: 'List Taggable Users'
      operationId: listTaggableUsers
      description: 'Get a paginated list of users that can be tagged in release forms. These are verified creators who have signed release forms to appear in your content. Use `offset` and `limit` for pagination.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of users to return per page (1-50). Must be at least 1. Must not be greater than 50.'
          example: 50
          required: false
          schema:
            type: integer
            description: 'Number of users to return per page (1-50). Must be at least 1. Must not be greater than 50.'
            example: 50
        -
          in: query
          name: offset
          description: 'Number of users to skip for pagination. Must be at least 0.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Number of users to skip for pagination. Must be at least 0.'
            example: 0
        -
          in: query
          name: filter
          description: 'Filter users by type: `all` or `pending`.'
          example: all
          required: false
          schema:
            type: string
            description: 'Filter users by type: `all` or `pending`.'
            example: all
            enum:
              - all
              - pending
            nullable: true
        -
          in: query
          name: sort
          description: 'Sort field: `date` or `name`.'
          example: date
          required: false
          schema:
            type: string
            description: 'Sort field: `date` or `name`.'
            example: date
            enum:
              - date
              - name
            nullable: true
        -
          in: query
          name: sortDirection
          description: 'Sort direction: `desc` or `asc`.'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort direction: `desc` or `asc`.'
            example: desc
            enum:
              - desc
              - asc
            nullable: true
        -
          in: query
          name: name
          description: 'Filter users by name or username.'
          example: null
          required: false
          schema:
            type: string
            description: 'Filter users by name or username.'
            example: null
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    items:
                      -
                        id: 26898170
                        name: 'Example User'
                        type: user
                        user:
                          view: tu
                          id: 26898170
                          name: 'Example User'
                          username: exampleuser
                          isVerified: true
                          avatar: 'https://public.onlyfans.com/files/.../26898170/avatar.jpg'
                          avatarThumbs:
                            c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../26898170/avatar.jpg'
                            c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../26898170/avatar.jpg'
                          ivStatus: approved
                          isFromGuest: false
                          hiddenForRf: false
                      -
                        id: 43888127
                        name: 'Another Creator'
                        type: user
                        user:
                          view: tu
                          id: 43888127
                          name: 'Another Creator'
                          username: anothercreator
                          isVerified: true
                          avatar: 'https://public.onlyfans.com/files/.../43888127/avatar.jpg'
                          avatarThumbs:
                            c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../43888127/avatar.jpg'
                            c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../43888127/avatar.jpg'
                          ivStatus: approved
                          isFromGuest: true
                          hiddenForRf: false
                    hasMore: true
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_abc123/release-forms/taggable-users?limit=50&offset=50'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999839
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49997
                properties:
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        example:
                          -
                            id: 26898170
                            name: 'Example User'
                            type: user
                            user:
                              view: tu
                              id: 26898170
                              name: 'Example User'
                              username: exampleuser
                              isVerified: true
                              avatar: 'https://public.onlyfans.com/files/.../26898170/avatar.jpg'
                              avatarThumbs:
                                c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../26898170/avatar.jpg'
                                c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../26898170/avatar.jpg'
                              ivStatus: approved
                              isFromGuest: false
                              hiddenForRf: false
                          -
                            id: 43888127
                            name: 'Another Creator'
                            type: user
                            user:
                              view: tu
                              id: 43888127
                              name: 'Another Creator'
                              username: anothercreator
                              isVerified: true
                              avatar: 'https://public.onlyfans.com/files/.../43888127/avatar.jpg'
                              avatarThumbs:
                                c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../43888127/avatar.jpg'
                                c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../43888127/avatar.jpg'
                              ivStatus: approved
                              isFromGuest: true
                              hiddenForRf: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 26898170
                            name:
                              type: string
                              example: 'Example User'
                            type:
                              type: string
                              example: user
                            user:
                              type: object
                              properties:
                                view:
                                  type: string
                                  example: tu
                                id:
                                  type: integer
                                  example: 26898170
                                name:
                                  type: string
                                  example: 'Example User'
                                username:
                                  type: string
                                  example: exampleuser
                                isVerified:
                                  type: boolean
                                  example: true
                                avatar:
                                  type: string
                                  example: 'https://public.onlyfans.com/files/.../26898170/avatar.jpg'
                                avatarThumbs:
                                  type: object
                                  properties:
                                    c50:
                                      type: string
                                      example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../26898170/avatar.jpg'
                                    c144:
                                      type: string
                                      example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../26898170/avatar.jpg'
                                ivStatus:
                                  type: string
                                  example: approved
                                isFromGuest:
                                  type: boolean
                                  example: false
                                hiddenForRf:
                                  type: boolean
                                  example: false
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_abc123/release-forms/taggable-users?limit=50&offset=50'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999839
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49997
      tags:
        - 'Release Forms'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/saved-for-later/messages':
    get:
      summary: 'List Saved For Later Messages'
      operationId: listSavedForLaterMessages
      description: 'List all messages that are marked as "Save For Later".'
      parameters:
        -
          in: query
          name: limit
          description: 'Maximum number of messages to return (default = 10)'
          example: 10
          required: true
          schema:
            type: integer
            description: 'Maximum number of messages to return (default = 10)'
            example: 10
        -
          in: query
          name: offset
          description: 'Offset for pagination (default = 0)'
          example: 0
          required: true
          schema:
            type: integer
            description: 'Offset for pagination (default = 0)'
            example: 0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        type: chat
                        publishDateTime: null
                        createdDateTime: '2025-01-01T01:01:01+01:01'
                        entity:
                          responseType: message
                          id: 123
                          text: '<p>Text</p>'
                          rawText: Text
                          giphyId: null
                          lockedText: false
                          isNew: true
                          isFree: true
                          isOpened: false
                          price: 0
                          isMediaReady: true
                          mediaCount: 0
                          media: []
                          previews: []
                          createdAt: '2025-01-01T01:01:01+01:01'
                          changedAt: '2025-01-01T01:01:01+01:01'
                          scheduledAt: null
                          isTip: false
                          cancelSeconds: 1000000
                          isLiked: false
                          canPurchase: false
                          isMarkdownDisabled: true
                          releaseForms: []
                          userIds:
                            - '123'
                          sentRulesType: user
                          sentRulesExtra: username
                          isFromQueue: true
                          queueId: 123
                          canUnsendQueue: true
                          unsendSecondsQueue: 1000000
                    hasMore: false
                    syncInProcess: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999943
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49974
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            type: chat
                            publishDateTime: null
                            createdDateTime: '2025-01-01T01:01:01+01:01'
                            entity:
                              responseType: message
                              id: 123
                              text: '<p>Text</p>'
                              rawText: Text
                              giphyId: null
                              lockedText: false
                              isNew: true
                              isFree: true
                              isOpened: false
                              price: 0
                              isMediaReady: true
                              mediaCount: 0
                              media: []
                              previews: []
                              createdAt: '2025-01-01T01:01:01+01:01'
                              changedAt: '2025-01-01T01:01:01+01:01'
                              scheduledAt: null
                              isTip: false
                              cancelSeconds: 1000000
                              isLiked: false
                              canPurchase: false
                              isMarkdownDisabled: true
                              releaseForms: []
                              userIds:
                                - '123'
                              sentRulesType: user
                              sentRulesExtra: username
                              isFromQueue: true
                              queueId: 123
                              canUnsendQueue: true
                              unsendSecondsQueue: 1000000
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: chat
                            publishDateTime:
                              type: string
                              example: null
                            createdDateTime:
                              type: string
                              example: '2025-01-01T01:01:01+01:01'
                            entity:
                              type: object
                              properties:
                                responseType:
                                  type: string
                                  example: message
                                id:
                                  type: integer
                                  example: 123
                                text:
                                  type: string
                                  example: '<p>Text</p>'
                                rawText:
                                  type: string
                                  example: Text
                                giphyId:
                                  type: string
                                  example: null
                                lockedText:
                                  type: boolean
                                  example: false
                                isNew:
                                  type: boolean
                                  example: true
                                isFree:
                                  type: boolean
                                  example: true
                                isOpened:
                                  type: boolean
                                  example: false
                                price:
                                  type: integer
                                  example: 0
                                isMediaReady:
                                  type: boolean
                                  example: true
                                mediaCount:
                                  type: integer
                                  example: 0
                                media:
                                  type: array
                                  example: []
                                previews:
                                  type: array
                                  example: []
                                createdAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+01:01'
                                changedAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+01:01'
                                scheduledAt:
                                  type: string
                                  example: null
                                isTip:
                                  type: boolean
                                  example: false
                                cancelSeconds:
                                  type: integer
                                  example: 1000000
                                isLiked:
                                  type: boolean
                                  example: false
                                canPurchase:
                                  type: boolean
                                  example: false
                                isMarkdownDisabled:
                                  type: boolean
                                  example: true
                                releaseForms:
                                  type: array
                                  example: []
                                userIds:
                                  type: array
                                  example:
                                    - '123'
                                  items:
                                    type: string
                                sentRulesType:
                                  type: string
                                  example: user
                                sentRulesExtra:
                                  type: string
                                  example: username
                                isFromQueue:
                                  type: boolean
                                  example: true
                                queueId:
                                  type: integer
                                  example: 123
                                canUnsendQueue:
                                  type: boolean
                                  example: true
                                unsendSecondsQueue:
                                  type: integer
                                  example: 1000000
                      hasMore:
                        type: boolean
                        example: false
                      syncInProcess:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999943
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49974
      tags:
        - 'Saved For Later (Messages)'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/saved-for-later/messages/settings':
    get:
      summary: 'Get Message Settings'
      operationId: getMessageSettings
      description: 'Get the Saved For Later message settings.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    currentCode: 12
                    isEnabled: false
                    options:
                      - 6
                      - 12
                      - 24
                      - 48
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999934
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49963
                properties:
                  data:
                    type: object
                    properties:
                      currentCode:
                        type: integer
                        example: 12
                      isEnabled:
                        type: boolean
                        example: false
                      options:
                        type: array
                        example:
                          - 6
                          - 12
                          - 24
                          - 48
                        items:
                          type: integer
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999934
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49963
      tags:
        - 'Saved For Later (Messages)'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/saved-for-later/messages/settings/enable-or-update-automatic-messaging':
    patch:
      summary: 'Enable/Update Automatic Messaging'
      operationId: enableUpdateAutomaticMessaging
      description: 'Enable or update automatic messaging of Saved For Later messages.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    period: 12
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999933
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49962
                properties:
                  data:
                    type: object
                    properties:
                      period:
                        type: integer
                        example: 12
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999933
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49962
      tags:
        - 'Saved For Later (Messages)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                period:
                  type: integer
                  description: 'The automatic messaging interval (in hours)'
                  example: 6
                  enum:
                    - 6
                    - 12
                    - 24
                    - 48
              required:
                - period
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/saved-for-later/messages/settings/disable-automatic-messaging':
    patch:
      summary: 'Disable Automatic Messaging'
      operationId: disableAutomaticMessaging
      description: 'Disable automatic messaging of Saved For Later messages.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999932
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49961
                properties:
                  data:
                    type: array
                    example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999932
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49961
      tags:
        - 'Saved For Later (Messages)'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/saved-for-later/posts':
    get:
      summary: 'List Saved For Later Posts'
      operationId: listSavedForLaterPosts
      description: 'List all posts that are marked as "Save For Later".'
      parameters:
        -
          in: query
          name: limit
          description: 'Maximum number of posts to return (default = 10)'
          example: 10
          required: true
          schema:
            type: integer
            description: 'Maximum number of posts to return (default = 10)'
            example: 10
        -
          in: query
          name: offset
          description: 'Offset for pagination (default = 0)'
          example: 0
          required: true
          schema:
            type: integer
            description: 'Offset for pagination (default = 0)'
            example: 0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        type: post
                        publishDateTime: null
                        createdDateTime: '2025-01-01T01:01:01+01:01'
                        entity:
                          responseType: post
                          id: 123
                          postedAt: '2025-01-01T01:01:01+01:01'
                          postedAtPrecise: '2025-01-01T01:01:01+01:01'
                          text: '<p>Text</p>'
                          isMarkdownDisabled: true
                          canDelete: true
                          canEdit: true
                          isMediaReady: true
                          isOpened: true
                          canToggleFavorite: true
                          tipsAmount: $0
                          isPublishedWithPeriod: true
                          rawText: Text
                          canViewMedia: true
                    hasMore: false
                    syncInProcess: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999942
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49973
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            type: post
                            publishDateTime: null
                            createdDateTime: '2025-01-01T01:01:01+01:01'
                            entity:
                              responseType: post
                              id: 123
                              postedAt: '2025-01-01T01:01:01+01:01'
                              postedAtPrecise: '2025-01-01T01:01:01+01:01'
                              text: '<p>Text</p>'
                              isMarkdownDisabled: true
                              canDelete: true
                              canEdit: true
                              isMediaReady: true
                              isOpened: true
                              canToggleFavorite: true
                              tipsAmount: $0
                              isPublishedWithPeriod: true
                              rawText: Text
                              canViewMedia: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: post
                            publishDateTime:
                              type: string
                              example: null
                            createdDateTime:
                              type: string
                              example: '2025-01-01T01:01:01+01:01'
                            entity:
                              type: object
                              properties:
                                responseType:
                                  type: string
                                  example: post
                                id:
                                  type: integer
                                  example: 123
                                postedAt:
                                  type: string
                                  example: '2025-01-01T01:01:01+01:01'
                                postedAtPrecise:
                                  type: string
                                  example: '2025-01-01T01:01:01+01:01'
                                text:
                                  type: string
                                  example: '<p>Text</p>'
                                isMarkdownDisabled:
                                  type: boolean
                                  example: true
                                canDelete:
                                  type: boolean
                                  example: true
                                canEdit:
                                  type: boolean
                                  example: true
                                isMediaReady:
                                  type: boolean
                                  example: true
                                isOpened:
                                  type: boolean
                                  example: true
                                canToggleFavorite:
                                  type: boolean
                                  example: true
                                tipsAmount:
                                  type: string
                                  example: $0
                                isPublishedWithPeriod:
                                  type: boolean
                                  example: true
                                rawText:
                                  type: string
                                  example: Text
                                canViewMedia:
                                  type: boolean
                                  example: true
                      hasMore:
                        type: boolean
                        example: false
                      syncInProcess:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999942
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49973
      tags:
        - 'Saved For Later (Posts)'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/saved-for-later/posts/settings':
    get:
      summary: 'Get Post Settings'
      operationId: getPostSettings
      description: 'Get the Saved For Later post settings.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    currentCode: 6
                    isEnabled: false
                    options:
                      - 6
                      - 12
                      - 24
                      - 48
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999941
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49972
                properties:
                  data:
                    type: object
                    properties:
                      currentCode:
                        type: integer
                        example: 6
                      isEnabled:
                        type: boolean
                        example: false
                      options:
                        type: array
                        example:
                          - 6
                          - 12
                          - 24
                          - 48
                        items:
                          type: integer
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999941
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49972
      tags:
        - 'Saved For Later (Posts)'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/saved-for-later/posts/settings/enable-or-update-automatic-posting':
    patch:
      summary: 'Enable/Update Automatic Posting'
      operationId: enableUpdateAutomaticPosting
      description: 'Enable or update automatic posting of Saved For Later posts.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    period: 6
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999940
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49969
                properties:
                  data:
                    type: object
                    properties:
                      period:
                        type: integer
                        example: 6
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999940
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49969
      tags:
        - 'Saved For Later (Posts)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                period:
                  type: integer
                  description: 'The automatic posting interval (in hours)'
                  example: 6
                  enum:
                    - 6
                    - 12
                    - 24
                    - 48
              required:
                - period
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/saved-for-later/posts/settings/disable-automatic-posting':
    patch:
      summary: 'Disable Automatic Posting'
      operationId: disableAutomaticPosting
      description: 'Disable automatic posting of Saved For Later posts.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999938
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49967
                properties:
                  data:
                    type: array
                    example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999938
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49967
      tags:
        - 'Saved For Later (Posts)'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/settings':
    get:
      summary: 'Get Settings'
      operationId: getSettings
      description: 'Returns the account settings'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    isDeleteInitiated: false
                    lastSubscriptionExpiredAt: null
                    streamingObsKey: abc123
                    streamingObsServer: 'rtmp://route0-dc2.onlyfans.com/live'
                    streamingMuxKey: null
                    streamingMuxServer: 'rtmps://global-live.mux.com:443/app'
                    streamingMuxKeyExpiredAt: null
                    activityHubAllowed: false
                    activityHubTokens: []
                    confirmEmailSentAt: '2025-01-01T00:00:00+00:00'
                    hideAfterMassMessages: true
                    changelogUpdates: 3
                    showFullTextInEmailNotify: false
                    isPrivate: true
                    blockedCountries: []
                    blockedStates: []
                    blockedIps: []
                    showPostsTips: true
                    recommenderReward: null
                    showFriendsToSubscribers: true
                    showSubscribesOffers: true
                    disableSubscribesOffers: true
                    isEmailNotificationsEnabled: false
                    canAcceptMessageOnlyFromFriends: false
                    isAutoFollowBack: true
                    unfollowAutoFollowBack: false
                    changeEmailStep: null
                    newEmail: null
                    lifeTimeEmailCode: null
                    coStreamingRequestFrom: subscribers
                    hasPaidPosts: false
                    isCoStreamingAllowed: true
                    isMonthlyNewsletters: false
                    strongOtp: false
                    phoneOtp: false
                    appOtp: false
                    isOtpAppConnected: false
                    isOldLoginRedirect: true
                    faceOtp: false
                    canSocialsConnect: true
                    socialsConnects: []
                    importantSubscriptionNotifications: true
                    isOpenseaConnected: false
                    forceFaceOtp: false
                    hasPassword: true
                    canAddSubscriberByBundle:
                      discounts:
                        '0': '0% discount'
                        '5': '5% discount'
                        '10': '10% discount'
                        '15': '15% discount'
                        '20': '20% discount'
                        '25': '25% discount'
                        '30': '30% discount'
                        '35': '35% discount'
                        '40': '40% discount'
                        '45': '45% discount'
                        '50': '50% discount'
                      durations:
                        '3': '3 months'
                        '6': '6 months'
                        '12': '12 months'
                    bundleMaxPrice: 250
                    canMakeProfileLinks: true
                    isSuggestionsOptOut: false
                    isTelegramConnected: false
                    replyOnSubscribe: false
                    shouldReceiveLessNotifications: false
                    avatarHeaderConverterUpload: true
                    streamingRtmpKey: abc123
                    streamingRtmpServer: 'rtmp://cloudbeta.streaming.onlyfans.com/live'
                    canAddPhone: true
                    phoneLast4: null
                    sendAwardsTop1: true
                    sendAwardsTop5: true
                    notifyOnAllMentions: false
                    commentsOnlyForPayers: false
                    isDrmEnabled: false
                    creatorsCommentsOnlyForFriends: false
                    muteTagsInChats: true
                    muteTagsInPosts: false
                    muteTagsInStories: true
                    muteTagsInStreams: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999983
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49986
                properties:
                  data:
                    type: object
                    properties:
                      isDeleteInitiated:
                        type: boolean
                        example: false
                      lastSubscriptionExpiredAt:
                        type: string
                        example: null
                      streamingObsKey:
                        type: string
                        example: abc123
                      streamingObsServer:
                        type: string
                        example: 'rtmp://route0-dc2.onlyfans.com/live'
                      streamingMuxKey:
                        type: string
                        example: null
                      streamingMuxServer:
                        type: string
                        example: 'rtmps://global-live.mux.com:443/app'
                      streamingMuxKeyExpiredAt:
                        type: string
                        example: null
                      activityHubAllowed:
                        type: boolean
                        example: false
                      activityHubTokens:
                        type: array
                        example: []
                      confirmEmailSentAt:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      hideAfterMassMessages:
                        type: boolean
                        example: true
                      changelogUpdates:
                        type: integer
                        example: 3
                      showFullTextInEmailNotify:
                        type: boolean
                        example: false
                      isPrivate:
                        type: boolean
                        example: true
                      blockedCountries:
                        type: array
                        example: []
                      blockedStates:
                        type: array
                        example: []
                      blockedIps:
                        type: array
                        example: []
                      showPostsTips:
                        type: boolean
                        example: true
                      recommenderReward:
                        type: string
                        example: null
                      showFriendsToSubscribers:
                        type: boolean
                        example: true
                      showSubscribesOffers:
                        type: boolean
                        example: true
                      disableSubscribesOffers:
                        type: boolean
                        example: true
                      isEmailNotificationsEnabled:
                        type: boolean
                        example: false
                      canAcceptMessageOnlyFromFriends:
                        type: boolean
                        example: false
                      isAutoFollowBack:
                        type: boolean
                        example: true
                      unfollowAutoFollowBack:
                        type: boolean
                        example: false
                      changeEmailStep:
                        type: string
                        example: null
                      newEmail:
                        type: string
                        example: null
                      lifeTimeEmailCode:
                        type: string
                        example: null
                      coStreamingRequestFrom:
                        type: string
                        example: subscribers
                      hasPaidPosts:
                        type: boolean
                        example: false
                      isCoStreamingAllowed:
                        type: boolean
                        example: true
                      isMonthlyNewsletters:
                        type: boolean
                        example: false
                      strongOtp:
                        type: boolean
                        example: false
                      phoneOtp:
                        type: boolean
                        example: false
                      appOtp:
                        type: boolean
                        example: false
                      isOtpAppConnected:
                        type: boolean
                        example: false
                      isOldLoginRedirect:
                        type: boolean
                        example: true
                      faceOtp:
                        type: boolean
                        example: false
                      canSocialsConnect:
                        type: boolean
                        example: true
                      socialsConnects:
                        type: array
                        example: []
                      importantSubscriptionNotifications:
                        type: boolean
                        example: true
                      isOpenseaConnected:
                        type: boolean
                        example: false
                      forceFaceOtp:
                        type: boolean
                        example: false
                      hasPassword:
                        type: boolean
                        example: true
                      canAddSubscriberByBundle:
                        type: object
                        properties:
                          discounts:
                            type: object
                            properties:
                              0:
                                type: string
                                example: '0% discount'
                              5:
                                type: string
                                example: '5% discount'
                              10:
                                type: string
                                example: '10% discount'
                              15:
                                type: string
                                example: '15% discount'
                              20:
                                type: string
                                example: '20% discount'
                              25:
                                type: string
                                example: '25% discount'
                              30:
                                type: string
                                example: '30% discount'
                              35:
                                type: string
                                example: '35% discount'
                              40:
                                type: string
                                example: '40% discount'
                              45:
                                type: string
                                example: '45% discount'
                              50:
                                type: string
                                example: '50% discount'
                          durations:
                            type: object
                            properties:
                              3:
                                type: string
                                example: '3 months'
                              6:
                                type: string
                                example: '6 months'
                              12:
                                type: string
                                example: '12 months'
                      bundleMaxPrice:
                        type: integer
                        example: 250
                      canMakeProfileLinks:
                        type: boolean
                        example: true
                      isSuggestionsOptOut:
                        type: boolean
                        example: false
                      isTelegramConnected:
                        type: boolean
                        example: false
                      replyOnSubscribe:
                        type: boolean
                        example: false
                      shouldReceiveLessNotifications:
                        type: boolean
                        example: false
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      streamingRtmpKey:
                        type: string
                        example: abc123
                      streamingRtmpServer:
                        type: string
                        example: 'rtmp://cloudbeta.streaming.onlyfans.com/live'
                      canAddPhone:
                        type: boolean
                        example: true
                      phoneLast4:
                        type: string
                        example: null
                      sendAwardsTop1:
                        type: boolean
                        example: true
                      sendAwardsTop5:
                        type: boolean
                        example: true
                      notifyOnAllMentions:
                        type: boolean
                        example: false
                      commentsOnlyForPayers:
                        type: boolean
                        example: false
                      isDrmEnabled:
                        type: boolean
                        example: false
                      creatorsCommentsOnlyForFriends:
                        type: boolean
                        example: false
                      muteTagsInChats:
                        type: boolean
                        example: true
                      muteTagsInPosts:
                        type: boolean
                        example: false
                      muteTagsInStories:
                        type: boolean
                        example: true
                      muteTagsInStreams:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999983
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49986
      tags:
        - Settings
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/settings/profile':
    post:
      summary: 'Update Profile'
      operationId: updateProfile
      description: 'Updates the account profile. **Only include the fields you want to update.** To make a field empty, set it to `null`.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49970
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49970
      tags:
        - Settings
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                  description: 'The new username to use. Make sure to first check if it exists using our `/settings/username-exists` endpoint.'
                  example: MyNewUsername
                name:
                  type: string
                  description: 'The new display name to use. Set to `null` to use the default display name.'
                  example: u1234
                  nullable: true
                avatar:
                  type: string
                  description: 'The new avatar to use. Must be a `ofapi_media_` ID. Refer to our `/media/upload` endpoint on how to get this.'
                  example: ofapi_media_abc123
                header:
                  type: string
                  description: 'The new header (banner) to use. Must be a `ofapi_media_` ID. Refer to our `/media/upload` endpoint on how to get this.'
                  example: ofapi_media_abc123
                about:
                  type: string
                  description: 'The new bio to use. Set to `null` to empty it.'
                  example: 'Hey there!'
                  nullable: true
                location:
                  type: string
                  description: 'The new location to use. Set to `null` to empty it.'
                  example: Europe
                  nullable: true
                website:
                  type: string
                  description: 'The new website URL to use. Must be a valid URL. Set to `null` to empty it.'
                  example: 'https://example.com'
                  nullable: true
                wishlist:
                  type: string
                  description: 'The new Amazon Wishlist URL to use. Must be a valid URL. Set to `null` to empty it.'
                  example: 'https://example.com'
                  nullable: true
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/settings/username-exists':
    post:
      summary: 'Check Username Availability'
      operationId: checkUsernameAvailability
      description: 'Check if a username is taken. Returns `false` if the username is available, `true` if it is already taken.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999972
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999994
                      remaining_day: 49973
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999972
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999994
                          remaining_day:
                            type: integer
                            example: 49973
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                  description: 'The username to check.'
                  example: MyNewUsername
              required:
                - username
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/settings/social-media-buttons/reorder':
    post:
      summary: 'Reorder Social Media Buttons'
      operationId: reorderSocialMediaButtons
      description: 'Changes the order of social media buttons for the account'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 123
                      sort: 0
                      label: Amazon
                      username: ''
                      socialMedia: amazon
                      link: 'https://amazon.com/example'
                      url: 'https://amazon.com/example'
                      isValid: true
                      clicks: 0
                    -
                      id: 1234
                      sort: 0
                      label: Instagram
                      username: example_user
                      socialMedia: instagram
                      link: ''
                      url: 'https://instagram.com/example_user'
                      isValid: true
                      clicks: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49996
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 123
                        sort: 0
                        label: Amazon
                        username: ''
                        socialMedia: amazon
                        link: 'https://amazon.com/example'
                        url: 'https://amazon.com/example'
                        isValid: true
                        clicks: 0
                      -
                        id: 1234
                        sort: 0
                        label: Instagram
                        username: example_user
                        socialMedia: instagram
                        link: ''
                        url: 'https://instagram.com/example_user'
                        isValid: true
                        clicks: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        sort:
                          type: integer
                          example: 0
                        label:
                          type: string
                          example: Amazon
                        username:
                          type: string
                          example: ''
                        socialMedia:
                          type: string
                          example: amazon
                        link:
                          type: string
                          example: 'https://amazon.com/example'
                        url:
                          type: string
                          example: 'https://amazon.com/example'
                        isValid:
                          type: boolean
                          example: true
                        clicks:
                          type: integer
                          example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                button_ids:
                  type: array
                  description: 'The new order of the buttons'
                  example:
                    - 123
                    - 456
                  items:
                    type: string
              required:
                - button_ids
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/settings/social-media-buttons':
    get:
      summary: 'List Social Media Buttons'
      operationId: listSocialMediaButtons
      description: 'Returns the list of social media buttons for the account'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 123
                      sort: 0
                      label: Amazon
                      username: ''
                      socialMedia: amazon
                      link: 'https://amazon.com/example'
                      url: 'https://amazon.com/example'
                      isValid: true
                      clicks: 0
                    -
                      id: 1234
                      sort: 0
                      label: Instagram
                      username: example_user
                      socialMedia: instagram
                      link: ''
                      url: 'https://instagram.com/example_user'
                      isValid: true
                      clicks: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999969
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49996
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 123
                        sort: 0
                        label: Amazon
                        username: ''
                        socialMedia: amazon
                        link: 'https://amazon.com/example'
                        url: 'https://amazon.com/example'
                        isValid: true
                        clicks: 0
                      -
                        id: 1234
                        sort: 0
                        label: Instagram
                        username: example_user
                        socialMedia: instagram
                        link: ''
                        url: 'https://instagram.com/example_user'
                        isValid: true
                        clicks: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        sort:
                          type: integer
                          example: 0
                        label:
                          type: string
                          example: Amazon
                        username:
                          type: string
                          example: ''
                        socialMedia:
                          type: string
                          example: amazon
                        link:
                          type: string
                          example: 'https://amazon.com/example'
                        url:
                          type: string
                          example: 'https://amazon.com/example'
                        isValid:
                          type: boolean
                          example: true
                        clicks:
                          type: integer
                          example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999969
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - Settings
    post:
      summary: 'Add Social Media Button'
      operationId: addSocialMediaButton
      description: 'Adds a new social media button to the account'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 123
                      sort: 0
                      label: Amazon
                      username: ''
                      socialMedia: amazon
                      link: 'https://amazon.com/example'
                      url: 'https://amazon.com/example'
                      isValid: true
                      clicks: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999959
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49986
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 123
                        sort: 0
                        label: Amazon
                        username: ''
                        socialMedia: amazon
                        link: 'https://amazon.com/example'
                        url: 'https://amazon.com/example'
                        isValid: true
                        clicks: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        sort:
                          type: integer
                          example: 0
                        label:
                          type: string
                          example: Amazon
                        username:
                          type: string
                          example: ''
                        socialMedia:
                          type: string
                          example: amazon
                        link:
                          type: string
                          example: 'https://amazon.com/example'
                        url:
                          type: string
                          example: 'https://amazon.com/example'
                        isValid:
                          type: boolean
                          example: true
                        clicks:
                          type: integer
                          example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999959
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49986
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: 'The button label'
                  example: Instagram
                type:
                  type: string
                  description: 'The button type'
                  example: Instagram
                  enum:
                    - instagram
                    - x
                    - facebook
                    - youtube
                    - tiktok
                    - snapchat
                    - amazon
                    - twitch
                    - discord
                    - patreon
                    - pinterest
                    - etsy
                    - bereal
                    - kick
                    - depop
                    - poshmark
                    - vsco
                    - threads
                    - throne
                    - shopltk
                    - oftv
                    - bluesky
                value:
                  type: string
                  description: 'The button value, either a username or link.'
                  example: example_user
              required:
                - label
                - type
                - value
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/settings/social-media-buttons/{button_id}':
    put:
      summary: 'Update Social Media Button'
      operationId: updateSocialMediaButton
      description: 'Updates a social media button from the account'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 3384764
                      sort: 0
                      label: new
                      username: test
                      socialMedia: instagram
                      link: ''
                      url: 'https://instagram.com/test'
                      isValid: true
                      clicks: 0
                    -
                      id: 3385711
                      sort: 1
                      label: X
                      username: test
                      socialMedia: x
                      link: ''
                      url: 'https://twitter.com/test'
                      isValid: true
                      clicks: 0
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999905
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 995
                      remaining_day: 49993
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 3384764
                        sort: 0
                        label: new
                        username: test
                        socialMedia: instagram
                        link: ''
                        url: 'https://instagram.com/test'
                        isValid: true
                        clicks: 0
                      -
                        id: 3385711
                        sort: 1
                        label: X
                        username: test
                        socialMedia: x
                        link: ''
                        url: 'https://twitter.com/test'
                        isValid: true
                        clicks: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 3384764
                        sort:
                          type: integer
                          example: 0
                        label:
                          type: string
                          example: new
                        username:
                          type: string
                          example: test
                        socialMedia:
                          type: string
                          example: instagram
                        link:
                          type: string
                          example: ''
                        url:
                          type: string
                          example: 'https://instagram.com/test'
                        isValid:
                          type: boolean
                          example: true
                        clicks:
                          type: integer
                          example: 0
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999905
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 995
                          remaining_day:
                            type: integer
                            example: 49993
      tags:
        - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  description: 'The new label for the button'
                  example: Instagram
              required:
                - label
    delete:
      summary: 'Delete Social Media Button'
      operationId: deleteSocialMediaButton
      description: 'Deletes a social media button from the account'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999960
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49987
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999960
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49987
      tags:
        - Settings
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: button_id
        description: 'The ID of the social media button to update'
        example: 123
        required: true
        schema:
          type: string
  /api/smart-links:
    get:
      summary: 'List Smart Links'
      operationId: listSmartLinks
      description: 'List all Smart Links'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of Smart Links to return. Default `50`'
          example: 50
          required: false
          schema:
            type: integer
            description: 'The number of Smart Links to return. Default `50`'
            example: 50
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: false
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 01JCZWQJZXQJZXQJZXQJZXQJZX
                      name: 'Instagram Bio Link'
                      link_type: free_trial
                      traffic_redirect_url: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX'
                      free_trial_days: 7
                      clicks_count: 150
                      conversions_count: 45
                      subscribers_count: 30
                      revenue: '1250.00'
                      account:
                        id: acct_XXXXXXXX
                        display_name: 'Example Creator'
                        username: examplecreator
                      created_at: '2025-01-15T10:30:00+00:00'
                      updated_at: '2025-01-15T10:30:00+00:00'
                    -
                      id: 01JCZWQJZXQJZXQJZXQJZXQJZY
                      name: 'Twitter Promo'
                      link_type: tracking_link
                      traffic_redirect_url: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZY'
                      free_trial_days: null
                      clicks_count: 320
                      conversions_count: 89
                      subscribers_count: 65
                      revenue: '2450.50'
                      account:
                        id: acct_XXXXXXXX
                        display_name: 'Example Creator'
                        username: examplecreator
                      created_at: '2025-01-10T08:15:00+00:00'
                      updated_at: '2025-01-10T08:15:00+00:00'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999985
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49988
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 01JCZWQJZXQJZXQJZXQJZXQJZX
                        name: 'Instagram Bio Link'
                        link_type: free_trial
                        traffic_redirect_url: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX'
                        free_trial_days: 7
                        clicks_count: 150
                        conversions_count: 45
                        subscribers_count: 30
                        revenue: '1250.00'
                        account:
                          id: acct_XXXXXXXX
                          display_name: 'Example Creator'
                          username: examplecreator
                        created_at: '2025-01-15T10:30:00+00:00'
                        updated_at: '2025-01-15T10:30:00+00:00'
                      -
                        id: 01JCZWQJZXQJZXQJZXQJZXQJZY
                        name: 'Twitter Promo'
                        link_type: tracking_link
                        traffic_redirect_url: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZY'
                        free_trial_days: null
                        clicks_count: 320
                        conversions_count: 89
                        subscribers_count: 65
                        revenue: '2450.50'
                        account:
                          id: acct_XXXXXXXX
                          display_name: 'Example Creator'
                          username: examplecreator
                        created_at: '2025-01-10T08:15:00+00:00'
                        updated_at: '2025-01-10T08:15:00+00:00'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 01JCZWQJZXQJZXQJZXQJZXQJZX
                        name:
                          type: string
                          example: 'Instagram Bio Link'
                        link_type:
                          type: string
                          example: free_trial
                        traffic_redirect_url:
                          type: string
                          example: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX'
                        free_trial_days:
                          type: integer
                          example: 7
                        clicks_count:
                          type: integer
                          example: 150
                        conversions_count:
                          type: integer
                          example: 45
                        subscribers_count:
                          type: integer
                          example: 30
                        revenue:
                          type: string
                          example: '1250.00'
                        account:
                          type: object
                          properties:
                            id:
                              type: string
                              example: acct_XXXXXXXX
                            display_name:
                              type: string
                              example: 'Example Creator'
                            username:
                              type: string
                              example: examplecreator
                        created_at:
                          type: string
                          example: '2025-01-15T10:30:00+00:00'
                        updated_at:
                          type: string
                          example: '2025-01-15T10:30:00+00:00'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999985
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Smart Links'
    post:
      summary: 'Create Smart Link'
      operationId: createSmartLink
      description: 'Create a new Smart Link for the account. Smart Links are pooled Free Trial or Tracking links that rotate inventory automatically.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 01JCZWQJZXQJZXQJZXQJZXQJZX
                    name: 'Instagram Bio Link'
                    link_type: free_trial
                    traffic_redirect_url: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX'
                    free_trial_days: 7
                    clicks_count: 0
                    conversions_count: 0
                    subscribers_count: 0
                    revenue: null
                    account:
                      id: acct_XXXXXXXX
                      display_name: 'Example Creator'
                      username: examplecreator
                    created_at: '2025-01-15T10:30:00+00:00'
                    updated_at: '2025-01-15T10:30:00+00:00'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999985
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
                      name:
                        type: string
                        example: 'Instagram Bio Link'
                      link_type:
                        type: string
                        example: free_trial
                      traffic_redirect_url:
                        type: string
                        example: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX'
                      free_trial_days:
                        type: integer
                        example: 7
                      clicks_count:
                        type: integer
                        example: 0
                      conversions_count:
                        type: integer
                        example: 0
                      subscribers_count:
                        type: integer
                        example: 0
                      revenue:
                        type: string
                        example: null
                      account:
                        type: object
                        properties:
                          id:
                            type: string
                            example: acct_XXXXXXXX
                          display_name:
                            type: string
                            example: 'Example Creator'
                          username:
                            type: string
                            example: examplecreator
                      created_at:
                        type: string
                        example: '2025-01-15T10:30:00+00:00'
                      updated_at:
                        type: string
                        example: '2025-01-15T10:30:00+00:00'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999985
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Smart Links'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type: string
                  description: 'The prefixed ID of the account to create the Smart Link for'
                  example: acct_XXXXXXXX
                name:
                  type: string
                  description: 'The name of the Smart Link'
                  example: 'Instagram Bio Link'
                link_type:
                  type: string
                  description: 'The type of Smart Link to create'
                  example: free_trial
                  enum:
                    - free_trial
                    - tracking_link
                free_trial_days:
                  type: integer
                  description: 'The number of free trial days (required if `link_type` is `free_trial`). Must be between 1 and 360.'
                  example: 7
              required:
                - account_id
                - name
                - link_type
  '/api/smart-links/{smart_link_id}':
    get:
      summary: 'Get Smart Link'
      operationId: getSmartLink
      description: 'Get a specific Smart Link by its ID'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 01JCZWQJZXQJZXQJZXQJZXQJZX
                    name: 'Instagram Bio Link'
                    link_type: free_trial
                    traffic_redirect_url: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX'
                    free_trial_days: 7
                    clicks_count: 150
                    conversions_count: 45
                    subscribers_count: 30
                    revenue: '1250.00'
                    account:
                      id: acct_XXXXXXXX
                      display_name: 'Example Creator'
                      username: examplecreator
                    created_at: '2025-01-15T10:30:00+00:00'
                    updated_at: '2025-01-15T10:30:00+00:00'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999985
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49988
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
                      name:
                        type: string
                        example: 'Instagram Bio Link'
                      link_type:
                        type: string
                        example: free_trial
                      traffic_redirect_url:
                        type: string
                        example: 'https://trk.of-traffic.com/go/01JCZWQJZXQJZXQJZXQJZXQJZX'
                      free_trial_days:
                        type: integer
                        example: 7
                      clicks_count:
                        type: integer
                        example: 150
                      conversions_count:
                        type: integer
                        example: 45
                      subscribers_count:
                        type: integer
                        example: 30
                      revenue:
                        type: string
                        example: '1250.00'
                      account:
                        type: object
                        properties:
                          id:
                            type: string
                            example: acct_XXXXXXXX
                          display_name:
                            type: string
                            example: 'Example Creator'
                          username:
                            type: string
                            example: examplecreator
                      created_at:
                        type: string
                        example: '2025-01-15T10:30:00+00:00'
                      updated_at:
                        type: string
                        example: '2025-01-15T10:30:00+00:00'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999985
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Smart Links'
    delete:
      summary: 'Delete Smart Link'
      operationId: deleteSmartLink
      description: 'Delete a Smart Link by its ID'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999986
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999997
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999986
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999997
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - 'Smart Links'
    parameters:
      -
        in: path
        name: smart_link_id
        description: 'The ID of the Smart Link'
        example: 01JCZWQJZXQJZXQJZXQJZXQJZX
        required: true
        schema:
          type: string
  '/api/{account}/smart-links/{smart_link_id}/stats':
    get:
      summary: 'Get Smart Link Stats'
      operationId: getSmartLinkStats
      description: 'Get dashboard-style summary plus daily and monthly metrics for a specific Smart Link on the current account'
      parameters:
        -
          in: query
          name: date_start
          description: 'Optional stats range start date'
          example: '2026-01-01T00:00:00Z'
          required: false
          schema:
            type: string
            description: 'Optional stats range start date'
            example: '2026-01-01T00:00:00Z'
        -
          in: query
          name: date_end
          description: 'Optional stats range end date'
          example: '2026-01-31T23:59:59Z'
          required: false
          schema:
            type: string
            description: 'Optional stats range end date'
            example: '2026-01-31T23:59:59Z'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      clicks_total: 150
                      subs_total: 45
                      revenue_total: 1250
                      spenders_total: 20
                    daily_metrics:
                      -
                        timestamp: '2026-01-30'
                        clicks: 9
                        subs: 2
                        revenue: 33
                        spenders: 1
                      -
                        timestamp: '2026-01-31'
                        clicks: 16
                        subs: 5
                        revenue: 95
                        spenders: 2
                    monthly_metrics:
                      -
                        timestamp: '2026-01-01'
                        clicks: 150
                        subs: 45
                        revenue: 1250
                        spenders: 20
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          clicks_total:
                            type: integer
                            example: 150
                          subs_total:
                            type: integer
                            example: 45
                          revenue_total:
                            type: integer
                            example: 1250
                          spenders_total:
                            type: integer
                            example: 20
                      daily_metrics:
                        type: array
                        example:
                          -
                            timestamp: '2026-01-30'
                            clicks: 9
                            subs: 2
                            revenue: 33
                            spenders: 1
                          -
                            timestamp: '2026-01-31'
                            clicks: 16
                            subs: 5
                            revenue: 95
                            spenders: 2
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: '2026-01-30'
                            clicks:
                              type: integer
                              example: 9
                            subs:
                              type: integer
                              example: 2
                            revenue:
                              type: integer
                              example: 33
                            spenders:
                              type: integer
                              example: 1
                      monthly_metrics:
                        type: array
                        example:
                          -
                            timestamp: '2026-01-01'
                            clicks: 150
                            subs: 45
                            revenue: 1250
                            spenders: 20
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: '2026-01-01'
                            clicks:
                              type: integer
                              example: 150
                            subs:
                              type: integer
                              example: 45
                            revenue:
                              type: integer
                              example: 1250
                            spenders:
                              type: integer
                              example: 20
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
      tags:
        - 'Smart Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: smart_link_id
        description: 'The ID of the smart link.'
        example: molestias
        required: true
        schema:
          type: string
  '/api/{account}/smart-links/{smart_link_id}/cohort-arps':
    get:
      summary: 'Get Smart Link Cohort ARPS'
      operationId: getSmartLinkCohortARPS
      description: 'Get per-link time-to-profit cohort ARPS windows for a specific Smart Link'
      parameters:
        -
          in: query
          name: acquisition_start
          description: 'Optional acquisition range start date'
          example: '2026-01-01T00:00:00Z'
          required: false
          schema:
            type: string
            description: 'Optional acquisition range start date'
            example: '2026-01-01T00:00:00Z'
        -
          in: query
          name: acquisition_end
          description: 'Optional acquisition range end date'
          example: '2026-01-31T23:59:59Z'
          required: false
          schema:
            type: string
            description: 'Optional acquisition range end date'
            example: '2026-01-31T23:59:59Z'
        -
          in: query
          name: revenue_basis
          description: 'Revenue basis. Defaults to `gross` for smart links.'
          example: gross
          required: false
          schema:
            type: string
            description: 'Revenue basis. Defaults to `gross` for smart links.'
            example: gross
            enum:
              - net
              - gross
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  error: 'Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API key.'
                properties:
                  error:
                    type: string
                    example: 'Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API key.'
      tags:
        - 'Smart Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: smart_link_id
        description: 'The ID of the smart link.'
        example: consequuntur
        required: true
        schema:
          type: string
  '/api/{account}/smart-links/{smart_link_id}/clicks':
    get:
      summary: 'List Smart Link Clicks'
      operationId: listSmartLinkClicks
      description: 'Query smart link clicks in a date range with optional bot/duplicate filtering'
      parameters:
        -
          in: query
          name: date_start
          description: 'Optional report range start date'
          example: '2026-01-01T00:00:00Z'
          required: false
          schema:
            type: string
            description: 'Optional report range start date'
            example: '2026-01-01T00:00:00Z'
        -
          in: query
          name: date_end
          description: 'Optional report range end date'
          example: '2026-01-07T23:59:59Z'
          required: false
          schema:
            type: string
            description: 'Optional report range end date'
            example: '2026-01-07T23:59:59Z'
        -
          in: query
          name: limit
          description: 'Rows per page. Default `100`'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Rows per page. Default `100`'
            example: 100
        -
          in: query
          name: offset
          description: 'Offset for pagination. Default `0`'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Offset for pagination. Default `0`'
            example: 0
        -
          in: query
          name: include_bots
          description: 'Include clicks marked as bots. Default `true`'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Include clicks marked as bots. Default `true`'
            example: true
        -
          in: query
          name: include_duplicates
          description: 'Include duplicate clicks. Default `true`'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Include duplicate clicks. Default `true`'
            example: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      clicks_total: 25
                    chart:
                      -
                        timestamp: '2026-01-30'
                        clicks: 10
                      -
                        timestamp: '2026-01-31'
                        clicks: 15
                    rows:
                      -
                        id: 01JTESTCLICK000000000000001
                        created_at: '2026-01-31T21:45:00+00:00'
                        referrer: example.com
                        ip_address: 192.168.1.10
                        user_agent: Mozilla/5.0
                        browser_device_type: Desktop
                        browser_name: Chrome
                        browser_family: Chrome
                        browser_platform: macOS
                        is_bot: false
                        is_duplicate: false
                        country_code: US
                        external_click_id: ext_123
                        gross_clicks: 1
                        fbclid: null
                        aff_s1: campaign-a
                        aff_s2: null
                        aff_s3: null
                        aff_s4: null
                        aff_s5: null
                        utm_source: google
                        utm_medium: cpc
                        utm_campaign: winter
                        utm_content: creative-a
                        utm_term: fans
                    filters:
                      date_start: '2026-01-25T00:00:00+00:00'
                      date_end: '2026-01-31T23:59:59+00:00'
                      limit: 100
                      offset: 0
                      include_bots: true
                      include_duplicates: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          clicks_total:
                            type: integer
                            example: 25
                      chart:
                        type: array
                        example:
                          -
                            timestamp: '2026-01-30'
                            clicks: 10
                          -
                            timestamp: '2026-01-31'
                            clicks: 15
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: '2026-01-30'
                            clicks:
                              type: integer
                              example: 10
                      rows:
                        type: array
                        example:
                          -
                            id: 01JTESTCLICK000000000000001
                            created_at: '2026-01-31T21:45:00+00:00'
                            referrer: example.com
                            ip_address: 192.168.1.10
                            user_agent: Mozilla/5.0
                            browser_device_type: Desktop
                            browser_name: Chrome
                            browser_family: Chrome
                            browser_platform: macOS
                            is_bot: false
                            is_duplicate: false
                            country_code: US
                            external_click_id: ext_123
                            gross_clicks: 1
                            fbclid: null
                            aff_s1: campaign-a
                            aff_s2: null
                            aff_s3: null
                            aff_s4: null
                            aff_s5: null
                            utm_source: google
                            utm_medium: cpc
                            utm_campaign: winter
                            utm_content: creative-a
                            utm_term: fans
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 01JTESTCLICK000000000000001
                            created_at:
                              type: string
                              example: '2026-01-31T21:45:00+00:00'
                            referrer:
                              type: string
                              example: example.com
                            ip_address:
                              type: string
                              example: 192.168.1.10
                            user_agent:
                              type: string
                              example: Mozilla/5.0
                            browser_device_type:
                              type: string
                              example: Desktop
                            browser_name:
                              type: string
                              example: Chrome
                            browser_family:
                              type: string
                              example: Chrome
                            browser_platform:
                              type: string
                              example: macOS
                            is_bot:
                              type: boolean
                              example: false
                            is_duplicate:
                              type: boolean
                              example: false
                            country_code:
                              type: string
                              example: US
                            external_click_id:
                              type: string
                              example: ext_123
                            gross_clicks:
                              type: integer
                              example: 1
                            fbclid:
                              type: string
                              example: null
                            aff_s1:
                              type: string
                              example: campaign-a
                            aff_s2:
                              type: string
                              example: null
                            aff_s3:
                              type: string
                              example: null
                            aff_s4:
                              type: string
                              example: null
                            aff_s5:
                              type: string
                              example: null
                            utm_source:
                              type: string
                              example: google
                            utm_medium:
                              type: string
                              example: cpc
                            utm_campaign:
                              type: string
                              example: winter
                            utm_content:
                              type: string
                              example: creative-a
                            utm_term:
                              type: string
                              example: fans
                      filters:
                        type: object
                        properties:
                          date_start:
                            type: string
                            example: '2026-01-25T00:00:00+00:00'
                          date_end:
                            type: string
                            example: '2026-01-31T23:59:59+00:00'
                          limit:
                            type: integer
                            example: 100
                          offset:
                            type: integer
                            example: 0
                          include_bots:
                            type: boolean
                            example: true
                          include_duplicates:
                            type: boolean
                            example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
      tags:
        - 'Smart Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: smart_link_id
        description: 'The ID of the smart link.'
        example: veritatis
        required: true
        schema:
          type: string
  '/api/{account}/smart-links/{smart_link_id}/conversions':
    get:
      summary: 'List Smart Link Conversions'
      operationId: listSmartLinkConversions
      description: 'Query smart link conversions in a date range with optional bot/duplicate and conversion type filtering'
      parameters:
        -
          in: query
          name: date_start
          description: 'Optional report range start date'
          example: '2026-01-01T00:00:00Z'
          required: false
          schema:
            type: string
            description: 'Optional report range start date'
            example: '2026-01-01T00:00:00Z'
        -
          in: query
          name: date_end
          description: 'Optional report range end date'
          example: '2026-01-07T23:59:59Z'
          required: false
          schema:
            type: string
            description: 'Optional report range end date'
            example: '2026-01-07T23:59:59Z'
        -
          in: query
          name: limit
          description: 'Rows per page. Default `100`'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Rows per page. Default `100`'
            example: 100
        -
          in: query
          name: offset
          description: 'Offset for pagination. Default `0`'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Offset for pagination. Default `0`'
            example: 0
        -
          in: query
          name: include_bots
          description: 'Include conversions from clicks marked as bots. Default `true`'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Include conversions from clicks marked as bots. Default `true`'
            example: true
        -
          in: query
          name: include_duplicates
          description: 'Include conversions from duplicate clicks. Default `true`'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Include conversions from duplicate clicks. Default `true`'
            example: true
        -
          in: query
          name: conversion_type
          description: 'Optional conversion type filter'
          example: new_transaction
          required: false
          schema:
            type: string
            description: 'Optional conversion type filter'
            example: new_transaction
            enum:
              - new_subscriber
              - new_transaction
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      conversions_total: 6
                      subscribers_total: 3
                      revenue_total: 240.5
                    chart:
                      -
                        timestamp: '2026-01-30'
                        conversions: 2
                      -
                        timestamp: '2026-01-31'
                        conversions: 4
                    rows:
                      -
                        id: 01JTESTCONV0000000000000001
                        conversion_type: new_transaction
                        amount_gross: 120.25
                        amount_net: 100.0
                        conversion_at: '2026-01-31T22:15:00+00:00'
                        fan_onlyfans_id: '123456789'
                        fan:
                          onlyfans_id: '123456789'
                          username: demo_fan
                          name: 'Demo Fan'
                          avatar_url: 'https://cdn.example.com/avatar.jpg'
                          onlyfans_url: 'https://onlyfans.com/demo_fan'
                        click:
                          id: 01JTESTCLICK000000000000001
                          created_at: '2026-01-31T21:45:00+00:00'
                          referrer: example.com
                          ip_address: 192.168.1.10
                          user_agent: Mozilla/5.0
                          browser_device_type: Desktop
                          browser_name: Chrome
                          browser_family: Chrome
                          browser_platform: macOS
                          is_bot: false
                          is_duplicate: false
                          country_code: US
                          external_click_id: ext_123
                          gross_clicks: 1
                          fbclid: null
                          aff_s1: campaign-a
                          aff_s2: null
                          aff_s3: null
                          aff_s4: null
                          aff_s5: null
                          utm_source: google
                          utm_medium: cpc
                          utm_campaign: winter
                          utm_content: creative-a
                          utm_term: fans
                    filters:
                      date_start: '2026-01-25T00:00:00+00:00'
                      date_end: '2026-01-31T23:59:59+00:00'
                      limit: 100
                      offset: 0
                      include_bots: true
                      include_duplicates: true
                      conversion_type: new_transaction
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          conversions_total:
                            type: integer
                            example: 6
                          subscribers_total:
                            type: integer
                            example: 3
                          revenue_total:
                            type: number
                            example: 240.5
                      chart:
                        type: array
                        example:
                          -
                            timestamp: '2026-01-30'
                            conversions: 2
                          -
                            timestamp: '2026-01-31'
                            conversions: 4
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: '2026-01-30'
                            conversions:
                              type: integer
                              example: 2
                      rows:
                        type: array
                        example:
                          -
                            id: 01JTESTCONV0000000000000001
                            conversion_type: new_transaction
                            amount_gross: 120.25
                            amount_net: 100
                            conversion_at: '2026-01-31T22:15:00+00:00'
                            fan_onlyfans_id: '123456789'
                            fan:
                              onlyfans_id: '123456789'
                              username: demo_fan
                              name: 'Demo Fan'
                              avatar_url: 'https://cdn.example.com/avatar.jpg'
                              onlyfans_url: 'https://onlyfans.com/demo_fan'
                            click:
                              id: 01JTESTCLICK000000000000001
                              created_at: '2026-01-31T21:45:00+00:00'
                              referrer: example.com
                              ip_address: 192.168.1.10
                              user_agent: Mozilla/5.0
                              browser_device_type: Desktop
                              browser_name: Chrome
                              browser_family: Chrome
                              browser_platform: macOS
                              is_bot: false
                              is_duplicate: false
                              country_code: US
                              external_click_id: ext_123
                              gross_clicks: 1
                              fbclid: null
                              aff_s1: campaign-a
                              aff_s2: null
                              aff_s3: null
                              aff_s4: null
                              aff_s5: null
                              utm_source: google
                              utm_medium: cpc
                              utm_campaign: winter
                              utm_content: creative-a
                              utm_term: fans
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 01JTESTCONV0000000000000001
                            conversion_type:
                              type: string
                              example: new_transaction
                            amount_gross:
                              type: number
                              example: 120.25
                            amount_net:
                              type: number
                              example: 100.0
                            conversion_at:
                              type: string
                              example: '2026-01-31T22:15:00+00:00'
                            fan_onlyfans_id:
                              type: string
                              example: '123456789'
                            fan:
                              type: object
                              properties:
                                onlyfans_id:
                                  type: string
                                  example: '123456789'
                                username:
                                  type: string
                                  example: demo_fan
                                name:
                                  type: string
                                  example: 'Demo Fan'
                                avatar_url:
                                  type: string
                                  example: 'https://cdn.example.com/avatar.jpg'
                                onlyfans_url:
                                  type: string
                                  example: 'https://onlyfans.com/demo_fan'
                            click:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 01JTESTCLICK000000000000001
                                created_at:
                                  type: string
                                  example: '2026-01-31T21:45:00+00:00'
                                referrer:
                                  type: string
                                  example: example.com
                                ip_address:
                                  type: string
                                  example: 192.168.1.10
                                user_agent:
                                  type: string
                                  example: Mozilla/5.0
                                browser_device_type:
                                  type: string
                                  example: Desktop
                                browser_name:
                                  type: string
                                  example: Chrome
                                browser_family:
                                  type: string
                                  example: Chrome
                                browser_platform:
                                  type: string
                                  example: macOS
                                is_bot:
                                  type: boolean
                                  example: false
                                is_duplicate:
                                  type: boolean
                                  example: false
                                country_code:
                                  type: string
                                  example: US
                                external_click_id:
                                  type: string
                                  example: ext_123
                                gross_clicks:
                                  type: integer
                                  example: 1
                                fbclid:
                                  type: string
                                  example: null
                                aff_s1:
                                  type: string
                                  example: campaign-a
                                aff_s2:
                                  type: string
                                  example: null
                                aff_s3:
                                  type: string
                                  example: null
                                aff_s4:
                                  type: string
                                  example: null
                                aff_s5:
                                  type: string
                                  example: null
                                utm_source:
                                  type: string
                                  example: google
                                utm_medium:
                                  type: string
                                  example: cpc
                                utm_campaign:
                                  type: string
                                  example: winter
                                utm_content:
                                  type: string
                                  example: creative-a
                                utm_term:
                                  type: string
                                  example: fans
                      filters:
                        type: object
                        properties:
                          date_start:
                            type: string
                            example: '2026-01-25T00:00:00+00:00'
                          date_end:
                            type: string
                            example: '2026-01-31T23:59:59+00:00'
                          limit:
                            type: integer
                            example: 100
                          offset:
                            type: integer
                            example: 0
                          include_bots:
                            type: boolean
                            example: true
                          include_duplicates:
                            type: boolean
                            example: true
                          conversion_type:
                            type: string
                            example: new_transaction
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
      tags:
        - 'Smart Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: smart_link_id
        description: 'The ID of the smart link.'
        example: sunt
        required: true
        schema:
          type: string
  '/api/{account}/statistics/total-transactions':
    get:
      summary: 'Calculate Total Transactions'
      operationId: calculateTotalTransactions
      description: 'Calculate the total transactions and amounts.'
      parameters:
        -
          in: query
          name: start_date
          description: 'The start date for the period. Keep empty to calculate everything.'
          example: '2025-01-01 00:00:00'
          required: true
          schema:
            type: string
            description: 'The start date for the period. Keep empty to calculate everything.'
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: end_date
          description: 'The end date for the period. Keep empty to calculate everything.'
          example: '2025-03-31 23:59:59'
          required: true
          schema:
            type: string
            description: 'The end date for the period. Keep empty to calculate everything.'
            example: '2025-03-31 23:59:59'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  total_transactions: 123
                  total_amount: 123.45
                properties:
                  total_transactions:
                    type: integer
                    example: 123
                  total_amount:
                    type: number
                    example: 123.45
      tags:
        - Statistics
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/statistics/overview':
    get:
      summary: 'Statistics Overview'
      operationId: statisticsOverview
      description: 'Get an overview of statistics for fans, visitors, posts, or general.'
      parameters:
        -
          in: query
          name: start_date
          description: "The start date for the statistics. Keep empty to retrieve from the model's start date."
          example: '2025-01-01 00:00:00'
          required: false
          schema:
            type: string
            description: "The start date for the statistics. Keep empty to retrieve from the model's start date."
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: end_date
          description: 'The end date for the statistics. Keep empty to retrieve until now.'
          example: '2025-03-31 23:59:59'
          required: false
          schema:
            type: string
            description: 'The end date for the statistics. Keep empty to retrieve until now.'
            example: '2025-03-31 23:59:59'
        -
          in: query
          name: type
          description: 'The type of statistics to retrieve (default = empty)'
          example: fans
          required: false
          schema:
            type: string
            description: 'The type of statistics to retrieve (default = empty)'
            example: fans
            enum:
              - fans
              - visitors
              - posts
              - messages
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    earning:
                      total: 123.45
                      gross: 123.45
                      delta: 1.6
                    posts:
                      hasStatistic: true
                      count:
                        total: 123
                        delta: 0
                      views:
                        total: 123
                        delta: -7.6
                      chartData:
                        -
                          date: '2025-01-01T00:00:00+00:00'
                          count: 123
                      earnings:
                        total: 123
                        gross: 123
                        delta: 123
                    streams:
                      hasStatistic: false
                      count:
                        total: 0m
                        delta: 0
                      views:
                        total: 0
                        delta: 0
                      chartData:
                        -
                          date: '2025-01-01T00:00:00+00:00'
                          count: 123
                      earnings:
                        total: 123
                        gross: 123
                        delta: 123
                    visitors:
                      hasStatistic: true
                      visitors:
                        total: 0
                        delta: -100
                      chartData:
                        -
                          date: '2025-01-01T00:00:00+00:00'
                          count: 123
                      earnings:
                        total: 123.45
                        gross: 123.45
                        delta: -10.9
                      subscriptions:
                        new:
                          total: 123
                          delta: -5.7
                        renew:
                          total: 123
                          delta: -17
                    massMessages:
                      hasStatistic: true
                      count:
                        total: 123
                        delta: 14.5
                      views:
                        total: 0
                        delta: 0
                      chartData:
                        -
                          date: '2025-01-01T00:00:00+00:00'
                          count: 123
                      earnings:
                        total: 123.45
                        delta: -0.1
                        gross: 123.45
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999254
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49979
                properties:
                  data:
                    type: object
                    properties:
                      earning:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 123.45
                          gross:
                            type: number
                            example: 123.45
                          delta:
                            type: number
                            example: 1.6
                      posts:
                        type: object
                        properties:
                          hasStatistic:
                            type: boolean
                            example: true
                          count:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              delta:
                                type: integer
                                example: 0
                          views:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              delta:
                                type: number
                                example: -7.6
                          chartData:
                            type: array
                            example:
                              -
                                date: '2025-01-01T00:00:00+00:00'
                                count: 123
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                count:
                                  type: integer
                                  example: 123
                          earnings:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              gross:
                                type: integer
                                example: 123
                              delta:
                                type: integer
                                example: 123
                      streams:
                        type: object
                        properties:
                          hasStatistic:
                            type: boolean
                            example: false
                          count:
                            type: object
                            properties:
                              total:
                                type: string
                                example: 0m
                              delta:
                                type: integer
                                example: 0
                          views:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 0
                              delta:
                                type: integer
                                example: 0
                          chartData:
                            type: array
                            example:
                              -
                                date: '2025-01-01T00:00:00+00:00'
                                count: 123
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                count:
                                  type: integer
                                  example: 123
                          earnings:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              gross:
                                type: integer
                                example: 123
                              delta:
                                type: integer
                                example: 123
                      visitors:
                        type: object
                        properties:
                          hasStatistic:
                            type: boolean
                            example: true
                          visitors:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 0
                              delta:
                                type: integer
                                example: -100
                          chartData:
                            type: array
                            example:
                              -
                                date: '2025-01-01T00:00:00+00:00'
                                count: 123
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                count:
                                  type: integer
                                  example: 123
                          earnings:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 123.45
                              gross:
                                type: number
                                example: 123.45
                              delta:
                                type: number
                                example: -10.9
                          subscriptions:
                            type: object
                            properties:
                              new:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  delta:
                                    type: number
                                    example: -5.7
                              renew:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  delta:
                                    type: integer
                                    example: -17
                      massMessages:
                        type: object
                        properties:
                          hasStatistic:
                            type: boolean
                            example: true
                          count:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 123
                              delta:
                                type: number
                                example: 14.5
                          views:
                            type: object
                            properties:
                              total:
                                type: integer
                                example: 0
                              delta:
                                type: integer
                                example: 0
                          chartData:
                            type: array
                            example:
                              -
                                date: '2025-01-01T00:00:00+00:00'
                                count: 123
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                count:
                                  type: integer
                                  example: 123
                          earnings:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 123.45
                              delta:
                                type: number
                                example: -0.1
                              gross:
                                type: number
                                example: 123.45
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999254
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49979
      tags:
        - Statistics
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/statistics/subscriber-metrics':
    get:
      summary: 'Get Subscriber Metrics'
      operationId: getSubscriberMetrics
      description: 'Get subscriber metrics including total, new, renewed, paid, and free subscriptions for a specified timeframe. `unknown_subscriptions` indicates deleted fan accounts.'
      parameters:
        -
          in: query
          name: start_date
          description: 'The start date for the metrics.'
          example: '2025-01-01 00:00:00'
          required: true
          schema:
            type: string
            description: 'The start date for the metrics.'
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: end_date
          description: 'The end date for the metrics.'
          example: '2025-03-31 23:59:59'
          required: true
          schema:
            type: string
            description: 'The end date for the metrics.'
            example: '2025-03-31 23:59:59'
        -
          in: query
          name: detailed
          description: 'Include paid and free fan metrics. Will slow down the response time, and might time out if timeframe is too large. Default = `false`'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Include paid and free fan metrics. Will slow down the response time, and might time out if timeframe is too large. Default = `false`'
            example: false
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    total_subscriptions: 10
                    new_subscriptions: 5
                    renewed_subscriptions: 5
                    detailed:
                      paid_subscriptions: 7
                      free_subscriptions: 2
                      unknown_subscriptions: 1
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999227
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49952
                properties:
                  data:
                    type: object
                    properties:
                      total_subscriptions:
                        type: integer
                        example: 10
                      new_subscriptions:
                        type: integer
                        example: 5
                      renewed_subscriptions:
                        type: integer
                        example: 5
                      detailed:
                        type: object
                        properties:
                          paid_subscriptions:
                            type: integer
                            example: 7
                          free_subscriptions:
                            type: integer
                            example: 2
                          unknown_subscriptions:
                            type: integer
                            example: 1
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999227
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49952
      tags:
        - Statistics
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/statistics/statements/earnings':
    get:
      summary: 'Get Earnings'
      operationId: getEarnings
      description: 'Get the earnings for a given period.'
      parameters:
        -
          in: query
          name: start_date
          description: 'The start date for the period'
          example: '2025-01-01 00:00:00'
          required: true
          schema:
            type: string
            description: 'The start date for the period'
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: end_date
          description: 'The end date for the period.'
          example: '2025-03-31 23:59:59'
          required: false
          schema:
            type: string
            description: 'The end date for the period.'
            example: '2025-03-31 23:59:59'
        -
          in: query
          name: type
          description: 'Filter by All / Subscriptions / Tips / Posts / Messages / Streams'
          example: total
          required: false
          schema:
            type: string
            description: 'Filter by All / Subscriptions / Tips / Posts / Messages / Streams'
            example: total
            enum:
              - total
              - subscribes
              - tips
              - post
              - messages
              - stream
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    total:
                      delta: -6.9
                      total: 662086.22
                      gross: 827634.52
                      chartCount:
                        -
                          date: '2025-01-01T00:00:00+00:00'
                          count: 540
                        -
                          date: '2025-01-02T00:00:00+00:00'
                          count: 451
                        -
                          date: '2025-01-03T00:00:00+00:00'
                          count: 501
                        -
                          date: '2025-01-04T00:00:00+00:00'
                          count: 417
                        -
                          date: '2025-01-05T00:00:00+00:00'
                          count: 515
                        -
                          date: '2025-01-06T00:00:00+00:00'
                          count: 488
                        -
                          date: '2025-01-07T00:00:00+00:00'
                          count: 481
                        -
                          date: '2025-01-08T00:00:00+00:00'
                          count: 444
                        -
                          date: '2025-01-09T00:00:00+00:00'
                          count: 510
                        -
                          date: '2025-01-10T00:00:00+00:00'
                          count: 424
                        -
                          date: '2025-01-11T00:00:00+00:00'
                          count: 360
                        -
                          date: '2025-01-12T00:00:00+00:00'
                          count: 396
                        -
                          date: '2025-01-13T00:00:00+00:00'
                          count: 434
                        -
                          date: '2025-01-14T00:00:00+00:00'
                          count: 392
                        -
                          date: '2025-01-15T00:00:00+00:00'
                          count: 368
                        -
                          date: '2025-01-16T00:00:00+00:00'
                          count: 402
                        -
                          date: '2025-01-17T00:00:00+00:00'
                          count: 393
                        -
                          date: '2025-01-18T00:00:00+00:00'
                          count: 360
                        -
                          date: '2025-01-19T00:00:00+00:00'
                          count: 438
                        -
                          date: '2025-01-20T00:00:00+00:00'
                          count: 420
                        -
                          date: '2025-01-21T00:00:00+00:00'
                          count: 314
                        -
                          date: '2025-01-22T00:00:00+00:00'
                          count: 384
                        -
                          date: '2025-01-23T00:00:00+00:00'
                          count: 408
                        -
                          date: '2025-01-24T00:00:00+00:00'
                          count: 384
                        -
                          date: '2025-01-25T00:00:00+00:00'
                          count: 468
                        -
                          date: '2025-01-26T00:00:00+00:00'
                          count: 609
                        -
                          date: '2025-01-27T00:00:00+00:00'
                          count: 514
                        -
                          date: '2025-01-28T00:00:00+00:00'
                          count: 438
                        -
                          date: '2025-01-29T00:00:00+00:00'
                          count: 421
                        -
                          date: '2025-01-30T00:00:00+00:00'
                          count: 494
                        -
                          date: '2025-01-31T00:00:00+00:00'
                          count: 487
                        -
                          date: '2025-02-01T00:00:00+00:00'
                          count: 523
                        -
                          date: '2025-02-02T00:00:00+00:00'
                          count: 572
                        -
                          date: '2025-02-03T00:00:00+00:00'
                          count: 468
                        -
                          date: '2025-02-04T00:00:00+00:00'
                          count: 433
                        -
                          date: '2025-02-05T00:00:00+00:00'
                          count: 544
                        -
                          date: '2025-02-06T00:00:00+00:00'
                          count: 641
                        -
                          date: '2025-02-07T00:00:00+00:00'
                          count: 524
                        -
                          date: '2025-02-08T00:00:00+00:00'
                          count: 522
                        -
                          date: '2025-02-09T00:00:00+00:00'
                          count: 454
                        -
                          date: '2025-02-10T00:00:00+00:00'
                          count: 596
                        -
                          date: '2025-02-11T00:00:00+00:00'
                          count: 540
                        -
                          date: '2025-02-12T00:00:00+00:00'
                          count: 466
                        -
                          date: '2025-02-13T00:00:00+00:00'
                          count: 519
                        -
                          date: '2025-02-14T00:00:00+00:00'
                          count: 513
                        -
                          date: '2025-02-15T00:00:00+00:00'
                          count: 487
                        -
                          date: '2025-02-16T00:00:00+00:00'
                          count: 412
                        -
                          date: '2025-02-17T00:00:00+00:00'
                          count: 404
                        -
                          date: '2025-02-18T00:00:00+00:00'
                          count: 472
                        -
                          date: '2025-02-19T00:00:00+00:00'
                          count: 355
                        -
                          date: '2025-02-20T00:00:00+00:00'
                          count: 481
                        -
                          date: '2025-02-21T00:00:00+00:00'
                          count: 485
                        -
                          date: '2025-02-22T00:00:00+00:00'
                          count: 439
                        -
                          date: '2025-02-23T00:00:00+00:00'
                          count: 412
                        -
                          date: '2025-02-24T00:00:00+00:00'
                          count: 434
                        -
                          date: '2025-02-25T00:00:00+00:00'
                          count: 397
                        -
                          date: '2025-02-26T00:00:00+00:00'
                          count: 368
                        -
                          date: '2025-02-27T00:00:00+00:00'
                          count: 518
                        -
                          date: '2025-02-28T00:00:00+00:00'
                          count: 565
                        -
                          date: '2025-03-01T00:00:00+00:00'
                          count: 564
                        -
                          date: '2025-03-02T00:00:00+00:00'
                          count: 581
                        -
                          date: '2025-03-03T00:00:00+00:00'
                          count: 444
                        -
                          date: '2025-03-04T00:00:00+00:00'
                          count: 457
                        -
                          date: '2025-03-05T00:00:00+00:00'
                          count: 507
                        -
                          date: '2025-03-06T00:00:00+00:00'
                          count: 510
                        -
                          date: '2025-03-07T00:00:00+00:00'
                          count: 474
                        -
                          date: '2025-03-08T00:00:00+00:00'
                          count: 543
                        -
                          date: '2025-03-09T00:00:00+00:00'
                          count: 529
                        -
                          date: '2025-03-10T00:00:00+00:00'
                          count: 520
                        -
                          date: '2025-03-11T00:00:00+00:00'
                          count: 498
                        -
                          date: '2025-03-12T00:00:00+00:00'
                          count: 457
                        -
                          date: '2025-03-13T00:00:00+00:00'
                          count: 497
                        -
                          date: '2025-03-14T00:00:00+00:00'
                          count: 532
                        -
                          date: '2025-03-15T00:00:00+00:00'
                          count: 491
                        -
                          date: '2025-03-16T00:00:00+00:00'
                          count: 413
                        -
                          date: '2025-03-17T00:00:00+00:00'
                          count: 426
                        -
                          date: '2025-03-18T00:00:00+00:00'
                          count: 491
                        -
                          date: '2025-03-19T00:00:00+00:00'
                          count: 386
                        -
                          date: '2025-03-20T00:00:00+00:00'
                          count: 476
                        -
                          date: '2025-03-21T00:00:00+00:00'
                          count: 420
                        -
                          date: '2025-03-22T00:00:00+00:00'
                          count: 426
                        -
                          date: '2025-03-23T00:00:00+00:00'
                          count: 533
                        -
                          date: '2025-03-24T00:00:00+00:00'
                          count: 406
                        -
                          date: '2025-03-25T00:00:00+00:00'
                          count: 400
                        -
                          date: '2025-03-26T00:00:00+00:00'
                          count: 435
                        -
                          date: '2025-03-27T00:00:00+00:00'
                          count: 514
                        -
                          date: '2025-03-28T00:00:00+00:00'
                          count: 503
                        -
                          date: '2025-03-29T00:00:00+00:00'
                          count: 446
                        -
                          date: '2025-03-30T00:00:00+00:00'
                          count: 437
                        -
                          date: '2025-03-31T00:00:00+00:00'
                          count: 415
                      chartAmount:
                        -
                          date: '2025-01-01T00:00:00+00:00'
                          count: 10051.89
                        -
                          date: '2025-01-02T00:00:00+00:00'
                          count: 7044.43
                        -
                          date: '2025-01-03T00:00:00+00:00'
                          count: 9070.46
                        -
                          date: '2025-01-04T00:00:00+00:00'
                          count: 7575.49
                        -
                          date: '2025-01-05T00:00:00+00:00'
                          count: 7459.01
                        -
                          date: '2025-01-06T00:00:00+00:00'
                          count: 8472.68
                        -
                          date: '2025-01-07T00:00:00+00:00'
                          count: 6410.23
                        -
                          date: '2025-01-08T00:00:00+00:00'
                          count: 6336.6
                        -
                          date: '2025-01-09T00:00:00+00:00'
                          count: 8475.93
                        -
                          date: '2025-01-10T00:00:00+00:00'
                          count: 7673.4
                        -
                          date: '2025-01-11T00:00:00+00:00'
                          count: 7666.22
                        -
                          date: '2025-01-12T00:00:00+00:00'
                          count: 8126.65
                        -
                          date: '2025-01-13T00:00:00+00:00'
                          count: 6278.71
                        -
                          date: '2025-01-14T00:00:00+00:00'
                          count: 7210.6
                        -
                          date: '2025-01-15T00:00:00+00:00'
                          count: 4610.57
                        -
                          date: '2025-01-16T00:00:00+00:00'
                          count: 5739.87
                        -
                          date: '2025-01-17T00:00:00+00:00'
                          count: 8435.22
                        -
                          date: '2025-01-18T00:00:00+00:00'
                          count: 5237.74
                        -
                          date: '2025-01-19T00:00:00+00:00'
                          count: 7315.44
                        -
                          date: '2025-01-20T00:00:00+00:00'
                          count: 7325.59
                        -
                          date: '2025-01-21T00:00:00+00:00'
                          count: 4510.83
                        -
                          date: '2025-01-22T00:00:00+00:00'
                          count: 6901.88
                        -
                          date: '2025-01-23T00:00:00+00:00'
                          count: 5442.49
                        -
                          date: '2025-01-24T00:00:00+00:00'
                          count: 6517.01
                        -
                          date: '2025-01-25T00:00:00+00:00'
                          count: 6882.58
                        -
                          date: '2025-01-26T00:00:00+00:00'
                          count: 8778.25
                        -
                          date: '2025-01-27T00:00:00+00:00'
                          count: 7759.99
                        -
                          date: '2025-01-28T00:00:00+00:00'
                          count: 6750.44
                        -
                          date: '2025-01-29T00:00:00+00:00'
                          count: 6338.93
                        -
                          date: '2025-01-30T00:00:00+00:00'
                          count: 7249.22
                        -
                          date: '2025-01-31T00:00:00+00:00'
                          count: 6299.92
                        -
                          date: '2025-02-01T00:00:00+00:00'
                          count: 8327.3
                        -
                          date: '2025-02-02T00:00:00+00:00'
                          count: 7675.32
                        -
                          date: '2025-02-03T00:00:00+00:00'
                          count: 7153.73
                        -
                          date: '2025-02-04T00:00:00+00:00'
                          count: 6711.74
                        -
                          date: '2025-02-05T00:00:00+00:00'
                          count: 7334.76
                        -
                          date: '2025-02-06T00:00:00+00:00'
                          count: 13641.27
                        -
                          date: '2025-02-07T00:00:00+00:00'
                          count: 9280.8
                        -
                          date: '2025-02-08T00:00:00+00:00'
                          count: 7978.69
                        -
                          date: '2025-02-09T00:00:00+00:00'
                          count: 8561.71
                        -
                          date: '2025-02-10T00:00:00+00:00'
                          count: 6979.16
                        -
                          date: '2025-02-11T00:00:00+00:00'
                          count: 7040.23
                        -
                          date: '2025-02-12T00:00:00+00:00'
                          count: 6701.16
                        -
                          date: '2025-02-13T00:00:00+00:00'
                          count: 7418.89
                        -
                          date: '2025-02-14T00:00:00+00:00'
                          count: 9174.97
                        -
                          date: '2025-02-15T00:00:00+00:00'
                          count: 8956.52
                        -
                          date: '2025-02-16T00:00:00+00:00'
                          count: 6561.58
                        -
                          date: '2025-02-17T00:00:00+00:00'
                          count: 5060.88
                        -
                          date: '2025-02-18T00:00:00+00:00'
                          count: 7721.78
                        -
                          date: '2025-02-19T00:00:00+00:00'
                          count: 6096.49
                        -
                          date: '2025-02-20T00:00:00+00:00'
                          count: 7017.78
                        -
                          date: '2025-02-21T00:00:00+00:00'
                          count: 9542.37
                        -
                          date: '2025-02-22T00:00:00+00:00'
                          count: 6882.54
                        -
                          date: '2025-02-23T00:00:00+00:00'
                          count: 5805.24
                        -
                          date: '2025-02-24T00:00:00+00:00'
                          count: 6612.35
                        -
                          date: '2025-02-25T00:00:00+00:00'
                          count: 4801.5
                        -
                          date: '2025-02-26T00:00:00+00:00'
                          count: 5793.31
                        -
                          date: '2025-02-27T00:00:00+00:00'
                          count: 7420.45
                        -
                          date: '2025-02-28T00:00:00+00:00'
                          count: 7238.34
                        -
                          date: '2025-03-01T00:00:00+00:00'
                          count: 8843.12
                        -
                          date: '2025-03-02T00:00:00+00:00'
                          count: 8087.79
                        -
                          date: '2025-03-03T00:00:00+00:00'
                          count: 7389.51
                        -
                          date: '2025-03-04T00:00:00+00:00'
                          count: 5521.31
                        -
                          date: '2025-03-05T00:00:00+00:00'
                          count: 8213.56
                        -
                          date: '2025-03-06T00:00:00+00:00'
                          count: 8016.33
                        -
                          date: '2025-03-07T00:00:00+00:00'
                          count: 7856.66
                        -
                          date: '2025-03-08T00:00:00+00:00'
                          count: 7283.95
                        -
                          date: '2025-03-09T00:00:00+00:00'
                          count: 9228.49
                        -
                          date: '2025-03-10T00:00:00+00:00'
                          count: 7571.83
                        -
                          date: '2025-03-11T00:00:00+00:00'
                          count: 7476.63
                        -
                          date: '2025-03-12T00:00:00+00:00'
                          count: 6336.17
                        -
                          date: '2025-03-13T00:00:00+00:00'
                          count: 8253.78
                        -
                          date: '2025-03-14T00:00:00+00:00'
                          count: 7627.9
                        -
                          date: '2025-03-15T00:00:00+00:00'
                          count: 7304.9
                        -
                          date: '2025-03-16T00:00:00+00:00'
                          count: 7900.93
                        -
                          date: '2025-03-17T00:00:00+00:00'
                          count: 6035.48
                        -
                          date: '2025-03-18T00:00:00+00:00'
                          count: 8107.57
                        -
                          date: '2025-03-19T00:00:00+00:00'
                          count: 6584.91
                        -
                          date: '2025-03-20T00:00:00+00:00'
                          count: 7021.49
                        -
                          date: '2025-03-21T00:00:00+00:00'
                          count: 6801.75
                        -
                          date: '2025-03-22T00:00:00+00:00'
                          count: 7950.66
                        -
                          date: '2025-03-23T00:00:00+00:00'
                          count: 9653.96
                        -
                          date: '2025-03-24T00:00:00+00:00'
                          count: 6069.97
                        -
                          date: '2025-03-25T00:00:00+00:00'
                          count: 6746.01
                        -
                          date: '2025-03-26T00:00:00+00:00'
                          count: 6619.57
                        -
                          date: '2025-03-27T00:00:00+00:00'
                          count: 8570.96
                        -
                          date: '2025-03-28T00:00:00+00:00'
                          count: 8294.75
                        -
                          date: '2025-03-29T00:00:00+00:00'
                          count: 7005.74
                        -
                          date: '2025-03-30T00:00:00+00:00'
                          count: 7233.87
                        -
                          date: '2025-03-31T00:00:00+00:00'
                          count: 7037.54
                  _meta:
                    _credits:
                      used: 1
                      balance: 25579
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 5000
                      remaining_minute: 997
                      remaining_day: 4981
                properties:
                  data:
                    type: object
                    properties:
                      total:
                        type: object
                        properties:
                          delta:
                            type: number
                            example: -6.9
                          total:
                            type: number
                            example: 662086.22
                          gross:
                            type: number
                            example: 827634.52
                          chartCount:
                            type: array
                            example:
                              -
                                date: '2025-01-01T00:00:00+00:00'
                                count: 540
                              -
                                date: '2025-01-02T00:00:00+00:00'
                                count: 451
                              -
                                date: '2025-01-03T00:00:00+00:00'
                                count: 501
                              -
                                date: '2025-01-04T00:00:00+00:00'
                                count: 417
                              -
                                date: '2025-01-05T00:00:00+00:00'
                                count: 515
                              -
                                date: '2025-01-06T00:00:00+00:00'
                                count: 488
                              -
                                date: '2025-01-07T00:00:00+00:00'
                                count: 481
                              -
                                date: '2025-01-08T00:00:00+00:00'
                                count: 444
                              -
                                date: '2025-01-09T00:00:00+00:00'
                                count: 510
                              -
                                date: '2025-01-10T00:00:00+00:00'
                                count: 424
                              -
                                date: '2025-01-11T00:00:00+00:00'
                                count: 360
                              -
                                date: '2025-01-12T00:00:00+00:00'
                                count: 396
                              -
                                date: '2025-01-13T00:00:00+00:00'
                                count: 434
                              -
                                date: '2025-01-14T00:00:00+00:00'
                                count: 392
                              -
                                date: '2025-01-15T00:00:00+00:00'
                                count: 368
                              -
                                date: '2025-01-16T00:00:00+00:00'
                                count: 402
                              -
                                date: '2025-01-17T00:00:00+00:00'
                                count: 393
                              -
                                date: '2025-01-18T00:00:00+00:00'
                                count: 360
                              -
                                date: '2025-01-19T00:00:00+00:00'
                                count: 438
                              -
                                date: '2025-01-20T00:00:00+00:00'
                                count: 420
                              -
                                date: '2025-01-21T00:00:00+00:00'
                                count: 314
                              -
                                date: '2025-01-22T00:00:00+00:00'
                                count: 384
                              -
                                date: '2025-01-23T00:00:00+00:00'
                                count: 408
                              -
                                date: '2025-01-24T00:00:00+00:00'
                                count: 384
                              -
                                date: '2025-01-25T00:00:00+00:00'
                                count: 468
                              -
                                date: '2025-01-26T00:00:00+00:00'
                                count: 609
                              -
                                date: '2025-01-27T00:00:00+00:00'
                                count: 514
                              -
                                date: '2025-01-28T00:00:00+00:00'
                                count: 438
                              -
                                date: '2025-01-29T00:00:00+00:00'
                                count: 421
                              -
                                date: '2025-01-30T00:00:00+00:00'
                                count: 494
                              -
                                date: '2025-01-31T00:00:00+00:00'
                                count: 487
                              -
                                date: '2025-02-01T00:00:00+00:00'
                                count: 523
                              -
                                date: '2025-02-02T00:00:00+00:00'
                                count: 572
                              -
                                date: '2025-02-03T00:00:00+00:00'
                                count: 468
                              -
                                date: '2025-02-04T00:00:00+00:00'
                                count: 433
                              -
                                date: '2025-02-05T00:00:00+00:00'
                                count: 544
                              -
                                date: '2025-02-06T00:00:00+00:00'
                                count: 641
                              -
                                date: '2025-02-07T00:00:00+00:00'
                                count: 524
                              -
                                date: '2025-02-08T00:00:00+00:00'
                                count: 522
                              -
                                date: '2025-02-09T00:00:00+00:00'
                                count: 454
                              -
                                date: '2025-02-10T00:00:00+00:00'
                                count: 596
                              -
                                date: '2025-02-11T00:00:00+00:00'
                                count: 540
                              -
                                date: '2025-02-12T00:00:00+00:00'
                                count: 466
                              -
                                date: '2025-02-13T00:00:00+00:00'
                                count: 519
                              -
                                date: '2025-02-14T00:00:00+00:00'
                                count: 513
                              -
                                date: '2025-02-15T00:00:00+00:00'
                                count: 487
                              -
                                date: '2025-02-16T00:00:00+00:00'
                                count: 412
                              -
                                date: '2025-02-17T00:00:00+00:00'
                                count: 404
                              -
                                date: '2025-02-18T00:00:00+00:00'
                                count: 472
                              -
                                date: '2025-02-19T00:00:00+00:00'
                                count: 355
                              -
                                date: '2025-02-20T00:00:00+00:00'
                                count: 481
                              -
                                date: '2025-02-21T00:00:00+00:00'
                                count: 485
                              -
                                date: '2025-02-22T00:00:00+00:00'
                                count: 439
                              -
                                date: '2025-02-23T00:00:00+00:00'
                                count: 412
                              -
                                date: '2025-02-24T00:00:00+00:00'
                                count: 434
                              -
                                date: '2025-02-25T00:00:00+00:00'
                                count: 397
                              -
                                date: '2025-02-26T00:00:00+00:00'
                                count: 368
                              -
                                date: '2025-02-27T00:00:00+00:00'
                                count: 518
                              -
                                date: '2025-02-28T00:00:00+00:00'
                                count: 565
                              -
                                date: '2025-03-01T00:00:00+00:00'
                                count: 564
                              -
                                date: '2025-03-02T00:00:00+00:00'
                                count: 581
                              -
                                date: '2025-03-03T00:00:00+00:00'
                                count: 444
                              -
                                date: '2025-03-04T00:00:00+00:00'
                                count: 457
                              -
                                date: '2025-03-05T00:00:00+00:00'
                                count: 507
                              -
                                date: '2025-03-06T00:00:00+00:00'
                                count: 510
                              -
                                date: '2025-03-07T00:00:00+00:00'
                                count: 474
                              -
                                date: '2025-03-08T00:00:00+00:00'
                                count: 543
                              -
                                date: '2025-03-09T00:00:00+00:00'
                                count: 529
                              -
                                date: '2025-03-10T00:00:00+00:00'
                                count: 520
                              -
                                date: '2025-03-11T00:00:00+00:00'
                                count: 498
                              -
                                date: '2025-03-12T00:00:00+00:00'
                                count: 457
                              -
                                date: '2025-03-13T00:00:00+00:00'
                                count: 497
                              -
                                date: '2025-03-14T00:00:00+00:00'
                                count: 532
                              -
                                date: '2025-03-15T00:00:00+00:00'
                                count: 491
                              -
                                date: '2025-03-16T00:00:00+00:00'
                                count: 413
                              -
                                date: '2025-03-17T00:00:00+00:00'
                                count: 426
                              -
                                date: '2025-03-18T00:00:00+00:00'
                                count: 491
                              -
                                date: '2025-03-19T00:00:00+00:00'
                                count: 386
                              -
                                date: '2025-03-20T00:00:00+00:00'
                                count: 476
                              -
                                date: '2025-03-21T00:00:00+00:00'
                                count: 420
                              -
                                date: '2025-03-22T00:00:00+00:00'
                                count: 426
                              -
                                date: '2025-03-23T00:00:00+00:00'
                                count: 533
                              -
                                date: '2025-03-24T00:00:00+00:00'
                                count: 406
                              -
                                date: '2025-03-25T00:00:00+00:00'
                                count: 400
                              -
                                date: '2025-03-26T00:00:00+00:00'
                                count: 435
                              -
                                date: '2025-03-27T00:00:00+00:00'
                                count: 514
                              -
                                date: '2025-03-28T00:00:00+00:00'
                                count: 503
                              -
                                date: '2025-03-29T00:00:00+00:00'
                                count: 446
                              -
                                date: '2025-03-30T00:00:00+00:00'
                                count: 437
                              -
                                date: '2025-03-31T00:00:00+00:00'
                                count: 415
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                count:
                                  type: integer
                                  example: 540
                          chartAmount:
                            type: array
                            example:
                              -
                                date: '2025-01-01T00:00:00+00:00'
                                count: 10051.89
                              -
                                date: '2025-01-02T00:00:00+00:00'
                                count: 7044.43
                              -
                                date: '2025-01-03T00:00:00+00:00'
                                count: 9070.46
                              -
                                date: '2025-01-04T00:00:00+00:00'
                                count: 7575.49
                              -
                                date: '2025-01-05T00:00:00+00:00'
                                count: 7459.01
                              -
                                date: '2025-01-06T00:00:00+00:00'
                                count: 8472.68
                              -
                                date: '2025-01-07T00:00:00+00:00'
                                count: 6410.23
                              -
                                date: '2025-01-08T00:00:00+00:00'
                                count: 6336.6
                              -
                                date: '2025-01-09T00:00:00+00:00'
                                count: 8475.93
                              -
                                date: '2025-01-10T00:00:00+00:00'
                                count: 7673.4
                              -
                                date: '2025-01-11T00:00:00+00:00'
                                count: 7666.22
                              -
                                date: '2025-01-12T00:00:00+00:00'
                                count: 8126.65
                              -
                                date: '2025-01-13T00:00:00+00:00'
                                count: 6278.71
                              -
                                date: '2025-01-14T00:00:00+00:00'
                                count: 7210.6
                              -
                                date: '2025-01-15T00:00:00+00:00'
                                count: 4610.57
                              -
                                date: '2025-01-16T00:00:00+00:00'
                                count: 5739.87
                              -
                                date: '2025-01-17T00:00:00+00:00'
                                count: 8435.22
                              -
                                date: '2025-01-18T00:00:00+00:00'
                                count: 5237.74
                              -
                                date: '2025-01-19T00:00:00+00:00'
                                count: 7315.44
                              -
                                date: '2025-01-20T00:00:00+00:00'
                                count: 7325.59
                              -
                                date: '2025-01-21T00:00:00+00:00'
                                count: 4510.83
                              -
                                date: '2025-01-22T00:00:00+00:00'
                                count: 6901.88
                              -
                                date: '2025-01-23T00:00:00+00:00'
                                count: 5442.49
                              -
                                date: '2025-01-24T00:00:00+00:00'
                                count: 6517.01
                              -
                                date: '2025-01-25T00:00:00+00:00'
                                count: 6882.58
                              -
                                date: '2025-01-26T00:00:00+00:00'
                                count: 8778.25
                              -
                                date: '2025-01-27T00:00:00+00:00'
                                count: 7759.99
                              -
                                date: '2025-01-28T00:00:00+00:00'
                                count: 6750.44
                              -
                                date: '2025-01-29T00:00:00+00:00'
                                count: 6338.93
                              -
                                date: '2025-01-30T00:00:00+00:00'
                                count: 7249.22
                              -
                                date: '2025-01-31T00:00:00+00:00'
                                count: 6299.92
                              -
                                date: '2025-02-01T00:00:00+00:00'
                                count: 8327.3
                              -
                                date: '2025-02-02T00:00:00+00:00'
                                count: 7675.32
                              -
                                date: '2025-02-03T00:00:00+00:00'
                                count: 7153.73
                              -
                                date: '2025-02-04T00:00:00+00:00'
                                count: 6711.74
                              -
                                date: '2025-02-05T00:00:00+00:00'
                                count: 7334.76
                              -
                                date: '2025-02-06T00:00:00+00:00'
                                count: 13641.27
                              -
                                date: '2025-02-07T00:00:00+00:00'
                                count: 9280.8
                              -
                                date: '2025-02-08T00:00:00+00:00'
                                count: 7978.69
                              -
                                date: '2025-02-09T00:00:00+00:00'
                                count: 8561.71
                              -
                                date: '2025-02-10T00:00:00+00:00'
                                count: 6979.16
                              -
                                date: '2025-02-11T00:00:00+00:00'
                                count: 7040.23
                              -
                                date: '2025-02-12T00:00:00+00:00'
                                count: 6701.16
                              -
                                date: '2025-02-13T00:00:00+00:00'
                                count: 7418.89
                              -
                                date: '2025-02-14T00:00:00+00:00'
                                count: 9174.97
                              -
                                date: '2025-02-15T00:00:00+00:00'
                                count: 8956.52
                              -
                                date: '2025-02-16T00:00:00+00:00'
                                count: 6561.58
                              -
                                date: '2025-02-17T00:00:00+00:00'
                                count: 5060.88
                              -
                                date: '2025-02-18T00:00:00+00:00'
                                count: 7721.78
                              -
                                date: '2025-02-19T00:00:00+00:00'
                                count: 6096.49
                              -
                                date: '2025-02-20T00:00:00+00:00'
                                count: 7017.78
                              -
                                date: '2025-02-21T00:00:00+00:00'
                                count: 9542.37
                              -
                                date: '2025-02-22T00:00:00+00:00'
                                count: 6882.54
                              -
                                date: '2025-02-23T00:00:00+00:00'
                                count: 5805.24
                              -
                                date: '2025-02-24T00:00:00+00:00'
                                count: 6612.35
                              -
                                date: '2025-02-25T00:00:00+00:00'
                                count: 4801.5
                              -
                                date: '2025-02-26T00:00:00+00:00'
                                count: 5793.31
                              -
                                date: '2025-02-27T00:00:00+00:00'
                                count: 7420.45
                              -
                                date: '2025-02-28T00:00:00+00:00'
                                count: 7238.34
                              -
                                date: '2025-03-01T00:00:00+00:00'
                                count: 8843.12
                              -
                                date: '2025-03-02T00:00:00+00:00'
                                count: 8087.79
                              -
                                date: '2025-03-03T00:00:00+00:00'
                                count: 7389.51
                              -
                                date: '2025-03-04T00:00:00+00:00'
                                count: 5521.31
                              -
                                date: '2025-03-05T00:00:00+00:00'
                                count: 8213.56
                              -
                                date: '2025-03-06T00:00:00+00:00'
                                count: 8016.33
                              -
                                date: '2025-03-07T00:00:00+00:00'
                                count: 7856.66
                              -
                                date: '2025-03-08T00:00:00+00:00'
                                count: 7283.95
                              -
                                date: '2025-03-09T00:00:00+00:00'
                                count: 9228.49
                              -
                                date: '2025-03-10T00:00:00+00:00'
                                count: 7571.83
                              -
                                date: '2025-03-11T00:00:00+00:00'
                                count: 7476.63
                              -
                                date: '2025-03-12T00:00:00+00:00'
                                count: 6336.17
                              -
                                date: '2025-03-13T00:00:00+00:00'
                                count: 8253.78
                              -
                                date: '2025-03-14T00:00:00+00:00'
                                count: 7627.9
                              -
                                date: '2025-03-15T00:00:00+00:00'
                                count: 7304.9
                              -
                                date: '2025-03-16T00:00:00+00:00'
                                count: 7900.93
                              -
                                date: '2025-03-17T00:00:00+00:00'
                                count: 6035.48
                              -
                                date: '2025-03-18T00:00:00+00:00'
                                count: 8107.57
                              -
                                date: '2025-03-19T00:00:00+00:00'
                                count: 6584.91
                              -
                                date: '2025-03-20T00:00:00+00:00'
                                count: 7021.49
                              -
                                date: '2025-03-21T00:00:00+00:00'
                                count: 6801.75
                              -
                                date: '2025-03-22T00:00:00+00:00'
                                count: 7950.66
                              -
                                date: '2025-03-23T00:00:00+00:00'
                                count: 9653.96
                              -
                                date: '2025-03-24T00:00:00+00:00'
                                count: 6069.97
                              -
                                date: '2025-03-25T00:00:00+00:00'
                                count: 6746.01
                              -
                                date: '2025-03-26T00:00:00+00:00'
                                count: 6619.57
                              -
                                date: '2025-03-27T00:00:00+00:00'
                                count: 8570.96
                              -
                                date: '2025-03-28T00:00:00+00:00'
                                count: 8294.75
                              -
                                date: '2025-03-29T00:00:00+00:00'
                                count: 7005.74
                              -
                                date: '2025-03-30T00:00:00+00:00'
                                count: 7233.87
                              -
                                date: '2025-03-31T00:00:00+00:00'
                                count: 7037.54
                            items:
                              type: object
                              properties:
                                date:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                count:
                                  type: number
                                  example: 10051.89
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 25579
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 5000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 4981
      tags:
        - Statistics
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/statistics/reach/profile-visitors':
    get:
      summary: 'Get Profile Visitors'
      operationId: getProfileVisitors
      description: 'Get the number of profile visitors for a given period.'
      parameters:
        -
          in: query
          name: start_date
          description: 'The start date for the period'
          example: '2025-01-01 00:00:00'
          required: true
          schema:
            type: string
            description: 'The start date for the period'
            example: '2025-01-01 00:00:00'
        -
          in: query
          name: end_date
          description: 'The end date for the period.'
          example: '2025-03-31 23:59:59'
          required: true
          schema:
            type: string
            description: 'The end date for the period.'
            example: '2025-03-31 23:59:59'
        -
          in: query
          name: type
          description: 'Filter all / users / guests'
          example: total
          required: false
          schema:
            type: string
            description: 'Filter all / users / guests'
            example: total
            enum:
              - total
              - users
              - guests
            nullable: true
        -
          in: query
          name: filter
          description: 'Optionally, filter the results by `chart` or `topCountries`. See example responses.'
          example: chart
          required: false
          schema:
            type: string
            description: 'Optionally, filter the results by `chart` or `topCountries`. See example responses.'
            example: chart
            enum:
              - chart
              - topCountries
            nullable: true
        -
          in: query
          name: limit
          description: 'Number of results to return'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of results to return'
            example: 10
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                  -
                    description: 'No filter'
                    type: object
                    example:
                      data:
                        isAvailable: true
                        topCountries:
                          hasMore: true
                          totals:
                            total: 123
                            guests: '123'
                            users: '123'
                            subscribers: 123
                          rows:
                            -
                              rank: 1
                              countryName: Australia
                              countryCode: AU
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 2
                              countryName: 'United States'
                              countryCode: US
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 3
                              countryName: Spain
                              countryCode: ES
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 4
                              countryName: 'United Kingdom'
                              countryCode: GB
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 5
                              countryName: Austria
                              countryCode: AT
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 6
                              countryName: Norway
                              countryCode: 'NO'
                              viewsCount:
                                total: 21
                                guests: 21
                                users: 0
                                subscribers: 0
                            -
                              rank: 7
                              countryName: Singapore
                              countryCode: SG
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 8
                              countryName: Germany
                              countryCode: DE
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 9
                              countryName: Mexico
                              countryCode: MX
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 10
                              countryName: Israel
                              countryCode: IL
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 11
                              countryName: Others
                              countryCode: ''
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                        topDurationUsers:
                          totals:
                            total: 123
                            guests: '123'
                            users: '123'
                            subscribers: 123
                        chart:
                          visitors:
                            -
                              date: '2025-01-01T00:00:00+00:00'
                              count: 123
                          duration:
                            -
                              date: '2025-01-01T00:00:00+00:00'
                              count: 123
                        total:
                          current: '123'
                          delta: 12.3
                        hasStats: true
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999818
                          note: Always
                        _cache:
                          is_cached: false
                          note: 'Cache disabled for this endpoint'
                        _rate_limits:
                          limit_minute: 1000
                          limit_day: 50000
                          remaining_minute: 999
                          remaining_day: 49963
                    properties:
                      data:
                        type: object
                        properties:
                          isAvailable:
                            type: boolean
                            example: true
                          topCountries:
                            type: object
                            properties:
                              hasMore:
                                type: boolean
                                example: true
                              totals:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  guests:
                                    type: string
                                    example: '123'
                                  users:
                                    type: string
                                    example: '123'
                                  subscribers:
                                    type: integer
                                    example: 123
                              rows:
                                type: array
                                example:
                                  -
                                    rank: 1
                                    countryName: Australia
                                    countryCode: AU
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 2
                                    countryName: 'United States'
                                    countryCode: US
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 3
                                    countryName: Spain
                                    countryCode: ES
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 4
                                    countryName: 'United Kingdom'
                                    countryCode: GB
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 5
                                    countryName: Austria
                                    countryCode: AT
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 6
                                    countryName: Norway
                                    countryCode: 'NO'
                                    viewsCount:
                                      total: 21
                                      guests: 21
                                      users: 0
                                      subscribers: 0
                                  -
                                    rank: 7
                                    countryName: Singapore
                                    countryCode: SG
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 8
                                    countryName: Germany
                                    countryCode: DE
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 9
                                    countryName: Mexico
                                    countryCode: MX
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 10
                                    countryName: Israel
                                    countryCode: IL
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 11
                                    countryName: Others
                                    countryCode: ''
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                items:
                                  type: object
                                  properties:
                                    rank:
                                      type: integer
                                      example: 1
                                    countryName:
                                      type: string
                                      example: Australia
                                    countryCode:
                                      type: string
                                      example: AU
                                    viewsCount:
                                      type: object
                                      properties: { total: { type: integer, example: 123 }, guests: { type: integer, example: 123 }, users: { type: integer, example: 123 }, subscribers: { type: integer, example: 123 } }
                          topDurationUsers:
                            type: object
                            properties:
                              totals:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  guests:
                                    type: string
                                    example: '123'
                                  users:
                                    type: string
                                    example: '123'
                                  subscribers:
                                    type: integer
                                    example: 123
                          chart:
                            type: object
                            properties:
                              visitors:
                                type: array
                                example:
                                  -
                                    date: '2025-01-01T00:00:00+00:00'
                                    count: 123
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      example: '2025-01-01T00:00:00+00:00'
                                    count:
                                      type: integer
                                      example: 123
                              duration:
                                type: array
                                example:
                                  -
                                    date: '2025-01-01T00:00:00+00:00'
                                    count: 123
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      example: '2025-01-01T00:00:00+00:00'
                                    count:
                                      type: integer
                                      example: 123
                          total:
                            type: object
                            properties:
                              current:
                                type: string
                                example: '123'
                              delta:
                                type: number
                                example: 12.3
                          hasStats:
                            type: boolean
                            example: true
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999818
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: 'Cache disabled for this endpoint'
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 1000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 999
                              remaining_day:
                                type: integer
                                example: 49963
                  -
                    description: 'Chart filter'
                    type: object
                    example:
                      data:
                        isAvailable: true
                        chart:
                          visitors:
                            -
                              date: '2025-01-01T00:00:00+00:00'
                              count: 123
                          duration:
                            -
                              date: '2025-01-01T00:00:00+00:00'
                              count: 123
                        total:
                          current: '123'
                          delta: 12.3
                        hasStats: false
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999815
                          note: Always
                        _cache:
                          is_cached: false
                          note: 'Cache disabled for this endpoint'
                        _rate_limits:
                          limit_minute: 1000
                          limit_day: 50000
                          remaining_minute: 999
                          remaining_day: 49960
                    properties:
                      data:
                        type: object
                        properties:
                          isAvailable:
                            type: boolean
                            example: true
                          chart:
                            type: object
                            properties:
                              visitors:
                                type: array
                                example:
                                  -
                                    date: '2025-01-01T00:00:00+00:00'
                                    count: 123
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      example: '2025-01-01T00:00:00+00:00'
                                    count:
                                      type: integer
                                      example: 123
                              duration:
                                type: array
                                example:
                                  -
                                    date: '2025-01-01T00:00:00+00:00'
                                    count: 123
                                items:
                                  type: object
                                  properties:
                                    date:
                                      type: string
                                      example: '2025-01-01T00:00:00+00:00'
                                    count:
                                      type: integer
                                      example: 123
                          total:
                            type: object
                            properties:
                              current:
                                type: string
                                example: '123'
                              delta:
                                type: number
                                example: 12.3
                          hasStats:
                            type: boolean
                            example: false
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999815
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: 'Cache disabled for this endpoint'
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 1000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 999
                              remaining_day:
                                type: integer
                                example: 49960
                  -
                    description: 'Top countries filter'
                    type: object
                    example:
                      data:
                        isAvailable: true
                        topCountries:
                          hasMore: true
                          totals:
                            total: 123
                            guests: '123'
                            users: '123'
                            subscribers: 123
                          rows:
                            -
                              rank: 1
                              countryName: 'United States'
                              countryCode: US
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 2
                              countryName: Australia
                              countryCode: AU
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 3
                              countryName: Canada
                              countryCode: CA
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 4
                              countryName: 'United Kingdom'
                              countryCode: GB
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 5
                              countryName: Germany
                              countryCode: DE
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 6
                              countryName: Mexico
                              countryCode: MX
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 7
                              countryName: 'Dominican Republic'
                              countryCode: DO
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 8
                              countryName: Brazil
                              countryCode: BR
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 9
                              countryName: Italy
                              countryCode: IT
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 10
                              countryName: Denmark
                              countryCode: DK
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                            -
                              rank: 11
                              countryName: Others
                              countryCode: ''
                              viewsCount:
                                total: 123
                                guests: 123
                                users: 123
                                subscribers: 123
                        hasStats: true
                      _meta:
                        _credits:
                          used: 1
                          balance: 999999814
                          note: Always
                        _cache:
                          is_cached: false
                          note: 'Cache disabled for this endpoint'
                        _rate_limits:
                          limit_minute: 1000
                          limit_day: 50000
                          remaining_minute: 998
                          remaining_day: 49959
                    properties:
                      data:
                        type: object
                        properties:
                          isAvailable:
                            type: boolean
                            example: true
                          topCountries:
                            type: object
                            properties:
                              hasMore:
                                type: boolean
                                example: true
                              totals:
                                type: object
                                properties:
                                  total:
                                    type: integer
                                    example: 123
                                  guests:
                                    type: string
                                    example: '123'
                                  users:
                                    type: string
                                    example: '123'
                                  subscribers:
                                    type: integer
                                    example: 123
                              rows:
                                type: array
                                example:
                                  -
                                    rank: 1
                                    countryName: 'United States'
                                    countryCode: US
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 2
                                    countryName: Australia
                                    countryCode: AU
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 3
                                    countryName: Canada
                                    countryCode: CA
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 4
                                    countryName: 'United Kingdom'
                                    countryCode: GB
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 5
                                    countryName: Germany
                                    countryCode: DE
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 6
                                    countryName: Mexico
                                    countryCode: MX
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 7
                                    countryName: 'Dominican Republic'
                                    countryCode: DO
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 8
                                    countryName: Brazil
                                    countryCode: BR
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 9
                                    countryName: Italy
                                    countryCode: IT
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 10
                                    countryName: Denmark
                                    countryCode: DK
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                  -
                                    rank: 11
                                    countryName: Others
                                    countryCode: ''
                                    viewsCount:
                                      total: 123
                                      guests: 123
                                      users: 123
                                      subscribers: 123
                                items:
                                  type: object
                                  properties:
                                    rank:
                                      type: integer
                                      example: 1
                                    countryName:
                                      type: string
                                      example: 'United States'
                                    countryCode:
                                      type: string
                                      example: US
                                    viewsCount:
                                      type: object
                                      properties: { total: { type: integer, example: 123 }, guests: { type: integer, example: 123 }, users: { type: integer, example: 123 }, subscribers: { type: integer, example: 123 } }
                          hasStats:
                            type: boolean
                            example: true
                      _meta:
                        type: object
                        properties:
                          _credits:
                            type: object
                            properties:
                              used:
                                type: integer
                                example: 1
                              balance:
                                type: integer
                                example: 999999814
                              note:
                                type: string
                                example: Always
                          _cache:
                            type: object
                            properties:
                              is_cached:
                                type: boolean
                                example: false
                              note:
                                type: string
                                example: 'Cache disabled for this endpoint'
                          _rate_limits:
                            type: object
                            properties:
                              limit_minute:
                                type: integer
                                example: 1000
                              limit_day:
                                type: integer
                                example: 50000
                              remaining_minute:
                                type: integer
                                example: 998
                              remaining_day:
                                type: integer
                                example: 49959
      tags:
        - Statistics
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/subscribers/statistics':
    get:
      summary: 'Get Subscriber Statistics'
      operationId: getSubscriberStatistics
      description: 'Get subscriber and earning statistics for an account for a specified timeframe. Optionally, filter by all, renews, or new subscribers.'
      parameters:
        -
          in: query
          name: start_date
          description: 'The start date for the period. Keep empty to calculate everything.'
          example: '2025-01-01 00:00:00'
          required: false
          schema:
            type: string
            description: 'The start date for the period. Keep empty to calculate everything.'
            example: '2025-01-01 00:00:00'
            nullable: true
        -
          in: query
          name: end_date
          description: 'The end date for the period. Keep empty to calculate everything.'
          example: '2025-03-31 23:59:59'
          required: false
          schema:
            type: string
            description: 'The end date for the period. Keep empty to calculate everything.'
            example: '2025-03-31 23:59:59'
            nullable: true
        -
          in: query
          name: type
          description: 'Filter the subscriber statistics (default = total)'
          example: total
          required: false
          schema:
            type: string
            description: 'Filter the subscriber statistics (default = total)'
            example: total
            enum:
              - total
              - renew
              - new
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    earnings:
                      -
                        date: '2025-01-01T00:00:00+00:00'
                        count: 12.34
                    subscribes:
                      -
                        date: '2025-01-01T00:00:00+00:00'
                        count: 123
                    total: 12.34
                    delta: 12.3
                    subscribers: 123
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999287
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49994
                properties:
                  data:
                    type: object
                    properties:
                      earnings:
                        type: array
                        example:
                          -
                            date: '2025-01-01T00:00:00+00:00'
                            count: 12.34
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            count:
                              type: number
                              example: 12.34
                      subscribes:
                        type: array
                        example:
                          -
                            date: '2025-01-01T00:00:00+00:00'
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            count:
                              type: integer
                              example: 123
                      total:
                        type: number
                        example: 12.34
                      delta:
                        type: number
                        example: 12.3
                      subscribers:
                        type: integer
                        example: 123
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999287
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49994
      tags:
        - Statistics
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/stories/archive':
    get:
      summary: 'List Story Archive'
      operationId: listStoryArchive
      description: 'Retrieve a list of your archived stories.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of stories to return (default = 18)'
          example: 18
          required: false
          schema:
            type: integer
            description: 'Number of stories to return (default = 18)'
            example: 18
        -
          in: query
          name: marker
          description: 'The marker used for pagination. Default: `null`'
          example: '1739155047'
          required: false
          schema:
            type: string
            description: 'The marker used for pagination. Default: `null`'
            example: '1739155047'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        createdAt: '2025-01-01T01:01:01+00:00'
                        media:
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T01:01:01+00:00'
                            isReady: true
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 600
                                height: 400
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 600
                                height: 400
                                size: 0
                                sources:
                                  w150: 'https://cdn2.onlyfans.com/files/...'
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                                sources:
                                  w150: 'https://thumbs.onlyfans.com/...'
                                  w480: 'https://thumbs.onlyfans.com/...'
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              '240': null
                              '720': null
                        question: null
                    marker: 123
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999751
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            createdAt: '2025-01-01T01:01:01+00:00'
                            media:
                              -
                                id: 123
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: '2025-01-01T01:01:01+00:00'
                                isReady: true
                                files:
                                  full:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 600
                                    height: 400
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 600
                                    height: 400
                                    size: 0
                                    sources:
                                      w150: 'https://cdn2.onlyfans.com/files/...'
                                  squarePreview:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 960
                                    height: 960
                                    size: 0
                                    sources:
                                      w150: 'https://thumbs.onlyfans.com/...'
                                      w480: 'https://thumbs.onlyfans.com/...'
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  240: null
                                  720: null
                            question: null
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            media:
                              type: array
                              example:
                                -
                                  id: 123
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: '2025-01-01T01:01:01+00:00'
                                  isReady: true
                                  files:
                                    full:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 600
                                      height: 400
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 600
                                      height: 400
                                      size: 0
                                      sources: { w150: 'https://cdn2.onlyfans.com/files/...' }
                                    squarePreview:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 960
                                      height: 960
                                      size: 0
                                      sources: { w150: 'https://thumbs.onlyfans.com/...', w480: 'https://thumbs.onlyfans.com/...' }
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    240: null
                                    720: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T01:01:01+00:00'
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 600 }, height: { type: integer, example: 400 }, size: { type: integer, example: 0 }, sources: { type: array, example: [] } } }
                                      thumb: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 300 }, height: { type: integer, example: 300 }, size: { type: integer, example: 0 } } }
                                      preview: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 600 }, height: { type: integer, example: 400 }, size: { type: integer, example: 0 }, sources: { type: object, properties: { w150: { type: string, example: 'https://cdn2.onlyfans.com/files/...' } } } } }
                                      squarePreview: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 960 }, height: { type: integer, example: 960 }, size: { type: integer, example: 0 }, sources: { type: object, properties: { w150: { type: string, example: 'https://thumbs.onlyfans.com/...' }, w480: { type: string, example: 'https://thumbs.onlyfans.com/...' } } } } }
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      240: { type: string, example: null }
                                      720: { type: string, example: null }
                            question:
                              type: string
                              example: null
                      marker:
                        type: integer
                        example: 123
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999751
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Stories
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/stories/{story_id}/stats':
    get:
      summary: 'Get Story Stats'
      operationId: getStoryStats
      description: 'Retrieve viewer count, likes count, comments count, and tips statistics for a specific story by its ID.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    storyLookCount: '123'
                    storyLookAll:
                      - '2025-01-01T01:01:01+00:00'
                    storyLikeCount: 123
                    storyLikeAll:
                      - '2025-01-01T01:01:01+00:00'
                    storyCommentCount: 123
                    storyCommentAll:
                      - '2025-01-01T01:01:01+00:00'
                    storyTipCount: 123
                    storyTipAll:
                      - '2025-01-01T01:01:01+00:00'
                    storyTipSum: 0
                    storyLookChart:
                      -
                        date: '2025-01-01T01:01:01+00:00'
                        count: 123
                      -
                        count: 123
                    storyLikeChart:
                      -
                        date: '2025-01-01T01:01:01+00:00'
                        count: 123
                    storyCommentChart:
                      -
                        date: '2025-01-01T01:01:01+00:00'
                        count: 123
                    storyTipChart:
                      -
                        date: '2025-01-01T01:01:01+00:00'
                        count: 123
                    storyTipSumChart:
                      -
                        date: '2025-01-01T01:01:01+00:00'
                        count: 123
                    createdAt: '2025-01-01T01:01:01+00:00'
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999719
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      storyLookCount:
                        type: string
                        example: '123'
                      storyLookAll:
                        type: array
                        example:
                          - '2025-01-01T01:01:01+00:00'
                        items:
                          type: string
                      storyLikeCount:
                        type: integer
                        example: 123
                      storyLikeAll:
                        type: array
                        example:
                          - '2025-01-01T01:01:01+00:00'
                        items:
                          type: string
                      storyCommentCount:
                        type: integer
                        example: 123
                      storyCommentAll:
                        type: array
                        example:
                          - '2025-01-01T01:01:01+00:00'
                        items:
                          type: string
                      storyTipCount:
                        type: integer
                        example: 123
                      storyTipAll:
                        type: array
                        example:
                          - '2025-01-01T01:01:01+00:00'
                        items:
                          type: string
                      storyTipSum:
                        type: integer
                        example: 0
                      storyLookChart:
                        type: array
                        example:
                          -
                            date: '2025-01-01T01:01:01+00:00'
                            count: 123
                          -
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            count:
                              type: integer
                              example: 123
                      storyLikeChart:
                        type: array
                        example:
                          -
                            date: '2025-01-01T01:01:01+00:00'
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            count:
                              type: integer
                              example: 123
                      storyCommentChart:
                        type: array
                        example:
                          -
                            date: '2025-01-01T01:01:01+00:00'
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            count:
                              type: integer
                              example: 123
                      storyTipChart:
                        type: array
                        example:
                          -
                            date: '2025-01-01T01:01:01+00:00'
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            count:
                              type: integer
                              example: 123
                      storyTipSumChart:
                        type: array
                        example:
                          -
                            date: '2025-01-01T01:01:01+00:00'
                            count: 123
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            count:
                              type: integer
                              example: 123
                      createdAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999719
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Stories
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: story_id
        description: 'The ID of the story to get stats for'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/stories/{story_id}/viewers':
    get:
      summary: 'List Story Viewers'
      operationId: listStoryViewers
      description: 'Retrieve the list of viewers for a specific story by its ID.'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of story viewers to return. Default `8`'
          example: 8
          required: false
          schema:
            type: integer
            description: 'The number of story viewers to return. Default `8`'
            example: 8
            nullable: true
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: false
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
            nullable: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    hasMore: true
                    list:
                      -
                        view: s
                        hasStoryTips: false
                        hasTopStoryTips: false
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 123
                        name: name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        isStoryLiked: false
                        isStoryBlockedUser: false
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: ''
                        listsStates:
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: USER_NOT_PERFORMER
                          -
                            id: rebill_off
                            type: rebill_off
                            name: 'Renew Off'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: rebill_on
                            type: rebill_on
                            name: 'Renew On'
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        showMediaCount: true
                        lastSeen: '2025-01-01T01:01:01+00:00'
                        canReport: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999710
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4996
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      hasMore:
                        type: boolean
                        example: true
                      list:
                        type: array
                        example:
                          -
                            view: s
                            hasStoryTips: false
                            hasTopStoryTips: false
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 123
                            name: name
                            username: username
                            canLookStory: true
                            canCommentStory: true
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            isStoryLiked: false
                            isStoryBlockedUser: false
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: ''
                            listsStates:
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: recent
                                type: recent
                                name: 'Recent (last 24 hours)'
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: USER_NOT_PERFORMER
                              -
                                id: rebill_off
                                type: rebill_off
                                name: 'Renew Off'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              -
                                id: rebill_on
                                type: rebill_on
                                name: 'Renew On'
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                            showMediaCount: true
                            lastSeen: '2025-01-01T01:01:01+00:00'
                            canReport: true
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: s
                            hasStoryTips:
                              type: boolean
                              example: false
                            hasTopStoryTips:
                              type: boolean
                              example: false
                            avatar:
                              type: string
                              example: null
                            avatarThumbs:
                              type: string
                              example: null
                            header:
                              type: string
                              example: null
                            headerSize:
                              type: string
                              example: null
                            headerThumbs:
                              type: string
                              example: null
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: true
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            isStoryLiked:
                              type: boolean
                              example: false
                            isStoryBlockedUser:
                              type: boolean
                              example: false
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: ''
                            listsStates:
                              type: array
                              example:
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: recent
                                  type: recent
                                  name: 'Recent (last 24 hours)'
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: USER_NOT_PERFORMER
                                -
                                  id: rebill_off
                                  type: rebill_off
                                  name: 'Renew Off'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                -
                                  id: rebill_on
                                  type: rebill_on
                                  name: 'Renew On'
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: fans
                                  type:
                                    type: string
                                    example: fans
                                  name:
                                    type: string
                                    example: Fans
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            showMediaCount:
                              type: boolean
                              example: true
                            lastSeen:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            canReport:
                              type: boolean
                              example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999710
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4996
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Stories
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: story_id
        description: 'The ID of the story to get viewers for'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/stories/{story_id}/mark-as-watched':
    post:
      summary: 'Mark Story as Watched'
      operationId: markStoryAsWatched
      description: 'Mark a specific story as watched by its ID.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999764
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999764
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Stories
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: story_id
        description: 'The ID of the story to mark as watched.'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/stories':
    get:
      summary: 'List Active Stories'
      operationId: listActiveStories
      description: 'Retrieve a list of your currently active stories.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 123
                      userId: 123
                      isReady: true
                      hasPost: false
                      isWatched: true
                      media:
                        -
                          id: 123
                          type: photo
                          convertedToVideo: false
                          canView: true
                          hasError: false
                          createdAt: '2025-01-01T01:01:01+00:00'
                          isReady: true
                          files:
                            full:
                              url: 'https://cdn2.onlyfans.com/files/...'
                              width: 600
                              height: 400
                              size: 0
                              sources: []
                            thumb:
                              url: 'https://cdn2.onlyfans.com/files/...'
                              width: 300
                              height: 300
                              size: 0
                            preview:
                              url: 'https://cdn2.onlyfans.com/files/...'
                              width: 600
                              height: 400
                              size: 0
                              sources:
                                w150: 'https://cdn2.onlyfans.com/files/...'
                            squarePreview:
                              url: 'https://cdn2.onlyfans.com/files/...'
                              width: 960
                              height: 960
                              size: 0
                              sources:
                                w150: 'https://thumbs.onlyfans.com/...'
                                w480: 'https://thumbs.onlyfans.com/...'
                          duration: 0
                          hasCustomPreview: false
                          videoSources:
                            '240': null
                            '720': null
                      createdAt: '2025-01-01T01:01:01+00:00'
                      question: null
                      viewersCount: 0
                      viewers: []
                      commentsCount: 0
                      canDelete: true
                      isHighlightCover: false
                      isLastInHighlight: false
                      tipsAmount: $0
                      tipsAmountRaw: 0
                      tipsCount: 0
                      likesCount: 0
                      releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999770
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4996
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 123
                        userId: 123
                        isReady: true
                        hasPost: false
                        isWatched: true
                        media:
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T01:01:01+00:00'
                            isReady: true
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 600
                                height: 400
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 600
                                height: 400
                                size: 0
                                sources:
                                  w150: 'https://cdn2.onlyfans.com/files/...'
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                                sources:
                                  w150: 'https://thumbs.onlyfans.com/...'
                                  w480: 'https://thumbs.onlyfans.com/...'
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                        createdAt: '2025-01-01T01:01:01+00:00'
                        question: null
                        viewersCount: 0
                        viewers: []
                        commentsCount: 0
                        canDelete: true
                        isHighlightCover: false
                        isLastInHighlight: false
                        tipsAmount: $0
                        tipsAmountRaw: 0
                        tipsCount: 0
                        likesCount: 0
                        releaseForms: []
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        userId:
                          type: integer
                          example: 123
                        isReady:
                          type: boolean
                          example: true
                        hasPost:
                          type: boolean
                          example: false
                        isWatched:
                          type: boolean
                          example: true
                        media:
                          type: array
                          example:
                            -
                              id: 123
                              type: photo
                              convertedToVideo: false
                              canView: true
                              hasError: false
                              createdAt: '2025-01-01T01:01:01+00:00'
                              isReady: true
                              files:
                                full:
                                  url: 'https://cdn2.onlyfans.com/files/...'
                                  width: 600
                                  height: 400
                                  size: 0
                                  sources: []
                                thumb:
                                  url: 'https://cdn2.onlyfans.com/files/...'
                                  width: 300
                                  height: 300
                                  size: 0
                                preview:
                                  url: 'https://cdn2.onlyfans.com/files/...'
                                  width: 600
                                  height: 400
                                  size: 0
                                  sources:
                                    w150: 'https://cdn2.onlyfans.com/files/...'
                                squarePreview:
                                  url: 'https://cdn2.onlyfans.com/files/...'
                                  width: 960
                                  height: 960
                                  size: 0
                                  sources:
                                    w150: 'https://thumbs.onlyfans.com/...'
                                    w480: 'https://thumbs.onlyfans.com/...'
                              duration: 0
                              hasCustomPreview: false
                              videoSources:
                                240: null
                                720: null
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 123
                              type:
                                type: string
                                example: photo
                              convertedToVideo:
                                type: boolean
                                example: false
                              canView:
                                type: boolean
                                example: true
                              hasError:
                                type: boolean
                                example: false
                              createdAt:
                                type: string
                                example: '2025-01-01T01:01:01+00:00'
                              isReady:
                                type: boolean
                                example: true
                              files:
                                type: object
                                properties:
                                  full:
                                    type: object
                                    properties:
                                      url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }
                                      width: { type: integer, example: 600 }
                                      height: { type: integer, example: 400 }
                                      size: { type: integer, example: 0 }
                                      sources: { type: array, example: [] }
                                  thumb:
                                    type: object
                                    properties:
                                      url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }
                                      width: { type: integer, example: 300 }
                                      height: { type: integer, example: 300 }
                                      size: { type: integer, example: 0 }
                                  preview:
                                    type: object
                                    properties:
                                      url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }
                                      width: { type: integer, example: 600 }
                                      height: { type: integer, example: 400 }
                                      size: { type: integer, example: 0 }
                                      sources: { type: object, properties: { w150: { type: string, example: 'https://cdn2.onlyfans.com/files/...' } } }
                                  squarePreview:
                                    type: object
                                    properties:
                                      url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }
                                      width: { type: integer, example: 960 }
                                      height: { type: integer, example: 960 }
                                      size: { type: integer, example: 0 }
                                      sources: { type: object, properties: { w150: { type: string, example: 'https://thumbs.onlyfans.com/...' }, w480: { type: string, example: 'https://thumbs.onlyfans.com/...' } } }
                              duration:
                                type: integer
                                example: 0
                              hasCustomPreview:
                                type: boolean
                                example: false
                              videoSources:
                                type: object
                                properties:
                                  240:
                                    type: string
                                    example: null
                                  720:
                                    type: string
                                    example: null
                        createdAt:
                          type: string
                          example: '2025-01-01T01:01:01+00:00'
                        question:
                          type: string
                          example: null
                        viewersCount:
                          type: integer
                          example: 0
                        viewers:
                          type: array
                          example: []
                        commentsCount:
                          type: integer
                          example: 0
                        canDelete:
                          type: boolean
                          example: true
                        isHighlightCover:
                          type: boolean
                          example: false
                        isLastInHighlight:
                          type: boolean
                          example: false
                        tipsAmount:
                          type: string
                          example: $0
                        tipsAmountRaw:
                          type: integer
                          example: 0
                        tipsCount:
                          type: integer
                          example: 0
                        likesCount:
                          type: integer
                          example: 0
                        releaseForms:
                          type: array
                          example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999770
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4996
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Stories
    post:
      summary: 'Add to Story'
      operationId: addToStory
      description: 'Post a new media or vault file to your story.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 123
                    isReady: false
                    hasPost: false
                    isWatched: false
                    media:
                      -
                        id: 123
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T01:01:01+00:00'
                        isReady: false
                        files:
                          full:
                            url: null
                            width: 0
                            height: 0
                            size: 0
                            sources: []
                          thumb: null
                          preview: null
                          squarePreview: null
                        duration: 0
                        hasCustomPreview: false
                    createdAt: '2025-01-01T01:01:01+00:00'
                    question: null
                    viewersCount: 0
                    viewers: []
                    commentsCount: 0
                    canDelete: true
                    isHighlightCover: false
                    isLastInHighlight: false
                    tipsAmount: $0
                    tipsAmountRaw: 0
                    tipsCount: 0
                    likesCount: 0
                    releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999771
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4995
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 123
                      isReady:
                        type: boolean
                        example: false
                      hasPost:
                        type: boolean
                        example: false
                      isWatched:
                        type: boolean
                        example: false
                      media:
                        type: array
                        example:
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T01:01:01+00:00'
                            isReady: false
                            files:
                              full:
                                url: null
                                width: 0
                                height: 0
                                size: 0
                                sources: []
                              thumb: null
                              preview: null
                              squarePreview: null
                            duration: 0
                            hasCustomPreview: false
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: photo
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            isReady:
                              type: boolean
                              example: false
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: null
                                    width:
                                      type: integer
                                      example: 0
                                    height:
                                      type: integer
                                      example: 0
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: string
                                  example: null
                                preview:
                                  type: string
                                  example: null
                                squarePreview:
                                  type: string
                                  example: null
                            duration:
                              type: integer
                              example: 0
                            hasCustomPreview:
                              type: boolean
                              example: false
                      createdAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      question:
                        type: string
                        example: null
                      viewersCount:
                        type: integer
                        example: 0
                      viewers:
                        type: array
                        example: []
                      commentsCount:
                        type: integer
                        example: 0
                      canDelete:
                        type: boolean
                        example: true
                      isHighlightCover:
                        type: boolean
                        example: false
                      isLastInHighlight:
                        type: boolean
                        example: false
                      tipsAmount:
                        type: string
                        example: $0
                      tipsAmountRaw:
                        type: integer
                        example: 0
                      tipsCount:
                        type: integer
                        example: 0
                      likesCount:
                        type: integer
                        example: 0
                      releaseForms:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999771
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4995
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Stories
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mediaFiles:
                  type: array
                  description: 'Array of media file upload prefixed_ids, or OF media IDs (required if price is not 0).'
                  example:
                    - ofapi_media_abc123
                    - 1234567890
                  items:
                    type: string
              required:
                - mediaFiles
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/stories/{story_id}':
    get:
      summary: 'Show Story'
      operationId: showStory
      description: 'Retrieve details of a specific story by its ID.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 123
                    isReady: true
                    hasPost: false
                    isWatched: false
                    media:
                      -
                        id: 213
                        type: photo
                        convertedToVideo: false
                        canView: true
                        hasError: false
                        createdAt: '2025-01-01T01:01:01+00:00'
                        isReady: true
                        files:
                          full:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 600
                            height: 400
                            size: 0
                            sources: []
                          thumb:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 300
                            height: 300
                            size: 0
                          preview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 600
                            height: 400
                            size: 0
                            sources:
                              w150: 'https://cdn2.onlyfans.com/files/...'
                          squarePreview:
                            url: 'https://cdn2.onlyfans.com/files/...'
                            width: 960
                            height: 960
                            size: 0
                            sources:
                              w150: 'https://thumbs.onlyfans.com/...'
                              w480: 'https://thumbs.onlyfans.com/...'
                        duration: 0
                        hasCustomPreview: false
                        videoSources:
                          '240': null
                          '720': null
                    createdAt: '2025-01-01T01:01:01+00:00'
                    question: null
                    viewersCount: 0
                    viewers: []
                    commentsCount: 0
                    canDelete: true
                    isHighlightCover: false
                    isLastInHighlight: false
                    tipsAmount: $0
                    tipsAmountRaw: 0
                    tipsCount: 0
                    likesCount: 0
                    releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999767
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4997
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 123
                      isReady:
                        type: boolean
                        example: true
                      hasPost:
                        type: boolean
                        example: false
                      isWatched:
                        type: boolean
                        example: false
                      media:
                        type: array
                        example:
                          -
                            id: 213
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T01:01:01+00:00'
                            isReady: true
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 600
                                height: 400
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 600
                                height: 400
                                size: 0
                                sources:
                                  w150: 'https://cdn2.onlyfans.com/files/...'
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                                sources:
                                  w150: 'https://thumbs.onlyfans.com/...'
                                  w480: 'https://thumbs.onlyfans.com/...'
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              240: null
                              720: null
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 213
                            type:
                              type: string
                              example: photo
                            convertedToVideo:
                              type: boolean
                              example: false
                            canView:
                              type: boolean
                              example: true
                            hasError:
                              type: boolean
                              example: false
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            isReady:
                              type: boolean
                              example: true
                            files:
                              type: object
                              properties:
                                full:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: 'https://cdn2.onlyfans.com/files/...'
                                    width:
                                      type: integer
                                      example: 600
                                    height:
                                      type: integer
                                      example: 400
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: array
                                      example: []
                                thumb:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: 'https://cdn2.onlyfans.com/files/...'
                                    width:
                                      type: integer
                                      example: 300
                                    height:
                                      type: integer
                                      example: 300
                                    size:
                                      type: integer
                                      example: 0
                                preview:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: 'https://cdn2.onlyfans.com/files/...'
                                    width:
                                      type: integer
                                      example: 600
                                    height:
                                      type: integer
                                      example: 400
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: object
                                      properties: { w150: { type: string, example: 'https://cdn2.onlyfans.com/files/...' } }
                                squarePreview:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      example: 'https://cdn2.onlyfans.com/files/...'
                                    width:
                                      type: integer
                                      example: 960
                                    height:
                                      type: integer
                                      example: 960
                                    size:
                                      type: integer
                                      example: 0
                                    sources:
                                      type: object
                                      properties: { w150: { type: string, example: 'https://thumbs.onlyfans.com/...' }, w480: { type: string, example: 'https://thumbs.onlyfans.com/...' } }
                            duration:
                              type: integer
                              example: 0
                            hasCustomPreview:
                              type: boolean
                              example: false
                            videoSources:
                              type: object
                              properties:
                                240:
                                  type: string
                                  example: null
                                720:
                                  type: string
                                  example: null
                      createdAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      question:
                        type: string
                        example: null
                      viewersCount:
                        type: integer
                        example: 0
                      viewers:
                        type: array
                        example: []
                      commentsCount:
                        type: integer
                        example: 0
                      canDelete:
                        type: boolean
                        example: true
                      isHighlightCover:
                        type: boolean
                        example: false
                      isLastInHighlight:
                        type: boolean
                        example: false
                      tipsAmount:
                        type: string
                        example: $0
                      tipsAmountRaw:
                        type: integer
                        example: 0
                      tipsCount:
                        type: integer
                        example: 0
                      likesCount:
                        type: integer
                        example: 0
                      releaseForms:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999767
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4997
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Stories
    delete:
      summary: 'Delete Story'
      operationId: deleteStory
      description: 'Delete a specific story by its ID.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999765
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999765
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Stories
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: story_id
        description: 'The ID of the story to retrieve'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/stories/highlights':
    get:
      summary: 'List Story Highlights'
      operationId: listStoryHighlights
      description: 'Retrieve a list of your story highlights.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of highlights to return (default = 5)'
          example: 5
          required: false
          schema:
            type: integer
            description: 'Number of highlights to return (default = 5)'
            example: 5
        -
          in: query
          name: offset
          description: 'Number of highlights to skip for pagination'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Number of highlights to skip for pagination'
            example: 0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123
                        userId: 123
                        title: title
                        coverStoryId: 123
                        cover: 'https://cdn2.onlyfans.com/files/...'
                        storiesCount: 1
                        createdAt: '2025-01-01T01:01:01+00:00'
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999744
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123
                            userId: 123
                            title: title
                            coverStoryId: 123
                            cover: 'https://cdn2.onlyfans.com/files/...'
                            storiesCount: 1
                            createdAt: '2025-01-01T01:01:01+00:00'
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            userId:
                              type: integer
                              example: 123
                            title:
                              type: string
                              example: title
                            coverStoryId:
                              type: integer
                              example: 123
                            cover:
                              type: string
                              example: 'https://cdn2.onlyfans.com/files/...'
                            storiesCount:
                              type: integer
                              example: 1
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999744
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Story Highlights'
    post:
      summary: 'Create Story Highlight'
      operationId: createStoryHighlight
      description: 'Create a new story highlight.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 123
                    title: title
                    coverStoryId: 123
                    cover: 'https://cdn2.onlyfans.com/files/...'
                    storiesCount: 1
                    createdAt: '2025-01-01T01:01:01+00:00'
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999735
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 123
                      title:
                        type: string
                        example: title
                      coverStoryId:
                        type: integer
                        example: 123
                      cover:
                        type: string
                        example: 'https://cdn2.onlyfans.com/files/...'
                      storiesCount:
                        type: integer
                        example: 1
                      createdAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999735
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Story Highlights'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'The title of the story highlight'
                  example: 'My Highlight'
                coverStoryId:
                  type: integer
                  description: 'The ID of the story to use as the cover for the highlight'
                  example: 9876543210
                storyIds:
                  type: array
                  description: 'An array of story IDs to include in the highlight'
                  example:
                    - 1234567890
                    - 2345678901
                  items:
                    type: string
              required:
                - title
                - coverStoryId
                - storyIds
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/stories/highlights/{highlight_id}':
    get:
      summary: 'Show Story Highlight'
      operationId: showStoryHighlight
      description: 'Retrieve details of a specific story highlight by its ID.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 123
                    title: title
                    coverStoryId: 123
                    cover: 'https://cdn2.onlyfans.com/files/...'
                    storiesCount: 1
                    createdAt: '2025-01-01T01:01:01+00:00'
                    stories:
                      -
                        id: 123
                        userId: 123
                        isReady: true
                        hasPost: false
                        isWatched: true
                        media:
                          -
                            id: 123
                            type: photo
                            convertedToVideo: false
                            canView: true
                            hasError: false
                            createdAt: '2025-01-01T01:01:01+00:00'
                            isReady: true
                            files:
                              full:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 1150
                                height: 760
                                size: 0
                                sources: []
                              thumb:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 300
                                height: 300
                                size: 0
                              preview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 635
                                size: 0
                                sources:
                                  w150: 'https://cdn2.onlyfans.com/files/...'
                              squarePreview:
                                url: 'https://cdn2.onlyfans.com/files/...'
                                width: 960
                                height: 960
                                size: 0
                                sources:
                                  w150: 'https://thumbs.onlyfans.com/...'
                                  w480: 'https://thumbs.onlyfans.com/...'
                            duration: 0
                            hasCustomPreview: false
                            videoSources:
                              '240': null
                              '720': null
                        createdAt: '2025-01-01T01:01:01+00:00'
                        canvasHeight: 760
                        canvasWidth: 1150
                        question: null
                        texts:
                          -
                            text: text
                            type: text
                            users: []
                            scale: 1.7996870109546
                            textAlign: left
                            textWidth: 242.23787167449
                            textHeight: 108.15055734597
                            color: '#ffffff'
                            bgColor: '#ff51dc'
                            fontFamily: Roboto
                            fontStyle: null
                            fontWeight: 400
                            top: 42.88483175
                            left: 39.46791862
                            angle: 0
                            fontSize: 19.88px
                            zIndex: 3
                        viewersCount: 0
                        viewers: []
                        commentsCount: 0
                        canDelete: true
                        isHighlightCover: true
                        isLastInHighlight: true
                        tipsAmount: $0
                        tipsAmountRaw: 0
                        tipsCount: 0
                        likesCount: 0
                        releaseForms: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999741
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4997
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 123
                      title:
                        type: string
                        example: title
                      coverStoryId:
                        type: integer
                        example: 123
                      cover:
                        type: string
                        example: 'https://cdn2.onlyfans.com/files/...'
                      storiesCount:
                        type: integer
                        example: 1
                      createdAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      stories:
                        type: array
                        example:
                          -
                            id: 123
                            userId: 123
                            isReady: true
                            hasPost: false
                            isWatched: true
                            media:
                              -
                                id: 123
                                type: photo
                                convertedToVideo: false
                                canView: true
                                hasError: false
                                createdAt: '2025-01-01T01:01:01+00:00'
                                isReady: true
                                files:
                                  full:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 1150
                                    height: 760
                                    size: 0
                                    sources: []
                                  thumb:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 300
                                    height: 300
                                    size: 0
                                  preview:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 960
                                    height: 635
                                    size: 0
                                    sources:
                                      w150: 'https://cdn2.onlyfans.com/files/...'
                                  squarePreview:
                                    url: 'https://cdn2.onlyfans.com/files/...'
                                    width: 960
                                    height: 960
                                    size: 0
                                    sources:
                                      w150: 'https://thumbs.onlyfans.com/...'
                                      w480: 'https://thumbs.onlyfans.com/...'
                                duration: 0
                                hasCustomPreview: false
                                videoSources:
                                  240: null
                                  720: null
                            createdAt: '2025-01-01T01:01:01+00:00'
                            canvasHeight: 760
                            canvasWidth: 1150
                            question: null
                            texts:
                              -
                                text: text
                                type: text
                                users: []
                                scale: 1.7996870109546
                                textAlign: left
                                textWidth: 242.23787167449
                                textHeight: 108.15055734597
                                color: '#ffffff'
                                bgColor: '#ff51dc'
                                fontFamily: Roboto
                                fontStyle: null
                                fontWeight: 400
                                top: 42.88483175
                                left: 39.46791862
                                angle: 0
                                fontSize: 19.88px
                                zIndex: 3
                            viewersCount: 0
                            viewers: []
                            commentsCount: 0
                            canDelete: true
                            isHighlightCover: true
                            isLastInHighlight: true
                            tipsAmount: $0
                            tipsAmountRaw: 0
                            tipsCount: 0
                            likesCount: 0
                            releaseForms: []
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            userId:
                              type: integer
                              example: 123
                            isReady:
                              type: boolean
                              example: true
                            hasPost:
                              type: boolean
                              example: false
                            isWatched:
                              type: boolean
                              example: true
                            media:
                              type: array
                              example:
                                -
                                  id: 123
                                  type: photo
                                  convertedToVideo: false
                                  canView: true
                                  hasError: false
                                  createdAt: '2025-01-01T01:01:01+00:00'
                                  isReady: true
                                  files:
                                    full:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 1150
                                      height: 760
                                      size: 0
                                      sources: []
                                    thumb:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 300
                                      height: 300
                                      size: 0
                                    preview:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 960
                                      height: 635
                                      size: 0
                                      sources: { w150: 'https://cdn2.onlyfans.com/files/...' }
                                    squarePreview:
                                      url: 'https://cdn2.onlyfans.com/files/...'
                                      width: 960
                                      height: 960
                                      size: 0
                                      sources: { w150: 'https://thumbs.onlyfans.com/...', w480: 'https://thumbs.onlyfans.com/...' }
                                  duration: 0
                                  hasCustomPreview: false
                                  videoSources:
                                    240: null
                                    720: null
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  type:
                                    type: string
                                    example: photo
                                  convertedToVideo:
                                    type: boolean
                                    example: false
                                  canView:
                                    type: boolean
                                    example: true
                                  hasError:
                                    type: boolean
                                    example: false
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T01:01:01+00:00'
                                  isReady:
                                    type: boolean
                                    example: true
                                  files:
                                    type: object
                                    properties:
                                      full: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 1150 }, height: { type: integer, example: 760 }, size: { type: integer, example: 0 }, sources: { type: array, example: [] } } }
                                      thumb: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 300 }, height: { type: integer, example: 300 }, size: { type: integer, example: 0 } } }
                                      preview: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 960 }, height: { type: integer, example: 635 }, size: { type: integer, example: 0 }, sources: { type: object, properties: { w150: { type: string, example: 'https://cdn2.onlyfans.com/files/...' } } } } }
                                      squarePreview: { type: object, properties: { url: { type: string, example: 'https://cdn2.onlyfans.com/files/...' }, width: { type: integer, example: 960 }, height: { type: integer, example: 960 }, size: { type: integer, example: 0 }, sources: { type: object, properties: { w150: { type: string, example: 'https://thumbs.onlyfans.com/...' }, w480: { type: string, example: 'https://thumbs.onlyfans.com/...' } } } } }
                                  duration:
                                    type: integer
                                    example: 0
                                  hasCustomPreview:
                                    type: boolean
                                    example: false
                                  videoSources:
                                    type: object
                                    properties:
                                      240: { type: string, example: null }
                                      720: { type: string, example: null }
                            createdAt:
                              type: string
                              example: '2025-01-01T01:01:01+00:00'
                            canvasHeight:
                              type: integer
                              example: 760
                            canvasWidth:
                              type: integer
                              example: 1150
                            question:
                              type: string
                              example: null
                            texts:
                              type: array
                              example:
                                -
                                  text: text
                                  type: text
                                  users: []
                                  scale: 1.7996870109546
                                  textAlign: left
                                  textWidth: 242.23787167449
                                  textHeight: 108.15055734597
                                  color: '#ffffff'
                                  bgColor: '#ff51dc'
                                  fontFamily: Roboto
                                  fontStyle: null
                                  fontWeight: 400
                                  top: 42.88483175
                                  left: 39.46791862
                                  angle: 0
                                  fontSize: 19.88px
                                  zIndex: 3
                              items:
                                type: object
                                properties:
                                  text:
                                    type: string
                                    example: text
                                  type:
                                    type: string
                                    example: text
                                  users:
                                    type: array
                                    example: []
                                  scale:
                                    type: number
                                    example: 1.7996870109546
                                  textAlign:
                                    type: string
                                    example: left
                                  textWidth:
                                    type: number
                                    example: 242.23787167449
                                  textHeight:
                                    type: number
                                    example: 108.15055734597
                                  color:
                                    type: string
                                    example: '#ffffff'
                                  bgColor:
                                    type: string
                                    example: '#ff51dc'
                                  fontFamily:
                                    type: string
                                    example: Roboto
                                  fontStyle:
                                    type: string
                                    example: null
                                  fontWeight:
                                    type: integer
                                    example: 400
                                  top:
                                    type: number
                                    example: 42.88483175
                                  left:
                                    type: number
                                    example: 39.46791862
                                  angle:
                                    type: integer
                                    example: 0
                                  fontSize:
                                    type: string
                                    example: 19.88px
                                  zIndex:
                                    type: integer
                                    example: 3
                            viewersCount:
                              type: integer
                              example: 0
                            viewers:
                              type: array
                              example: []
                            commentsCount:
                              type: integer
                              example: 0
                            canDelete:
                              type: boolean
                              example: true
                            isHighlightCover:
                              type: boolean
                              example: true
                            isLastInHighlight:
                              type: boolean
                              example: true
                            tipsAmount:
                              type: string
                              example: $0
                            tipsAmountRaw:
                              type: integer
                              example: 0
                            tipsCount:
                              type: integer
                              example: 0
                            likesCount:
                              type: integer
                              example: 0
                            releaseForms:
                              type: array
                              example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999741
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4997
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Story Highlights'
    put:
      summary: 'Update Story Highlight'
      operationId: updateStoryHighlight
      description: 'Update the details of a specific story highlight by its ID.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    userId: 132
                    title: title
                    coverStoryId: 123
                    cover: 'https://cdn2.onlyfans.com/files/...'
                    storiesCount: 2
                    createdAt: '2025-01-01T01:01:01+00:00'
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999738
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4996
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      userId:
                        type: integer
                        example: 132
                      title:
                        type: string
                        example: title
                      coverStoryId:
                        type: integer
                        example: 123
                      cover:
                        type: string
                        example: 'https://cdn2.onlyfans.com/files/...'
                      storiesCount:
                        type: integer
                        example: 2
                      createdAt:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999738
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4996
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Story Highlights'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: "The new title for the story highlight. Provide the old value if you don't want to change it."
                  example: 'My Updated Highlight'
                coverStoryId:
                  type: integer
                  description: "The ID of the story to use as the cover for the highlight. Provide the old value if you don't want to change it."
                  example: 9876543210
                storyIds:
                  type: array
                  description: "An array of story IDs to include in the highlight. Provide the old value if you don't want to change it."
                  example:
                    - 1234567890
                    - 2345678901
                  items:
                    type: string
              required:
                - title
                - coverStoryId
                - storyIds
    delete:
      summary: 'Delete Story Highlight'
      operationId: deleteStoryHighlight
      description: 'Delete a specific story highlight by its ID.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999736
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999736
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Story Highlights'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: highlight_id
        description: 'The ID of the story highlight to retrieve'
        example: 1234567890
        required: true
        schema:
          type: integer
  '/api/{account}/stories/highlights/{highlight_id}/{story_id}':
    patch:
      summary: 'Add Story to Highlight'
      operationId: addStoryToHighlight
      description: 'Add a specific story to a story highlight.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999728
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999728
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Story Highlights'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                story_id:
                  type: integer
                  description: 'The ID of the story to add to the highlight'
                  example: 2345678901
              required:
                - story_id
    delete:
      summary: 'Remove Story from Highlight'
      operationId: removeStoryFromHighlight
      description: 'Remove a specific story from a story highlight.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 1000999729
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 1000999729
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Story Highlights'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: highlight_id
        description: 'The ID of the story highlight to add the story to'
        example: 1234567890
        required: true
        schema:
          type: integer
      -
        in: path
        name: story_id
        description: 'The ID of the story.'
        example: consequatur
        required: true
        schema:
          type: string
  '/api/{account}/bundles':
    get:
      summary: 'List Bundles'
      operationId: listBundles
      description: 'List all bundles for the account.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 123
                      discount: 15
                      duration: 12
                      price: 123
                      canBuy: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999814
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 123
                        discount: 15
                        duration: 12
                        price: 123
                        canBuy: false
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        discount:
                          type: integer
                          example: 15
                        duration:
                          type: integer
                          example: 12
                        price:
                          type: integer
                          example: 123
                        canBuy:
                          type: boolean
                          example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999814
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Subscription Bundles'
    post:
      summary: 'Create Bundle'
      operationId: createBundle
      description: 'Create a new bundle for the account.'
      parameters:
        -
          in: query
          name: discount
          description: "The bundle's discount percentage."
          example: 10
          required: true
          schema:
            type: integer
            description: "The bundle's discount percentage."
            example: 10
            enum:
              - 0
              - 5
              - 10
              - 15
              - 20
              - 25
              - 30
              - 35
              - 40
              - 45
              - 50
        -
          in: query
          name: duration
          description: "The bundle's duration in months."
          example: 10
          required: true
          schema:
            type: integer
            description: "The bundle's duration in months."
            example: 10
            enum:
              - 3
              - 6
              - 12
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    discount: 15
                    duration: 12
                    price: 123
                    canBuy: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999813
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 996
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      discount:
                        type: integer
                        example: 15
                      duration:
                        type: integer
                        example: 12
                      price:
                        type: integer
                        example: 123
                      canBuy:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999813
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Subscription Bundles'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/bundles/{bundle_id}':
    delete:
      summary: 'Delete Bundle'
      operationId: deleteBundle
      description: 'Delete a bundle for the account.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    discount: 15
                    duration: 12
                    price: 123
                    canBuy: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999813
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 996
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      discount:
                        type: integer
                        example: 15
                      duration:
                        type: integer
                        example: 12
                      price:
                        type: integer
                        example: 123
                      canBuy:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999813
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Subscription Bundles'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: bundle_id
        description: 'The ID of the bundle to delete.'
        example: 123
        required: true
        schema:
          type: string
  '/api/{account}/tracking-links/{tracking_link_id}/subscribers':
    get:
      summary: 'List Tracking Link Subscribers'
      operationId: listTrackingLinkSubscribers
      description: 'Get list of subscribers who joined through a Tracking Link'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of subscribers to return per page. Default `10`'
          example: 10
          required: true
          schema:
            type: integer
            description: 'The number of subscribers to return per page. Default `10`'
            example: 10
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: true
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: s
                        avatar: 'https://example.com/avatar1.jpg'
                        avatarThumbs:
                          c50: 'https://example.com/avatar1_thumb50.jpg'
                          c144: 'https://example.com/avatar1_thumb144.jpg'
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000001
                        name: User1
                        username: user1
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: ''
                        lastSeen: null
                        canReport: false
                      -
                        view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000002
                        name: User2
                        username: user2
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: ''
                        lastSeen: '2025-02-10T19:35:01+00:00'
                        canReport: false
                      -
                        view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000003
                        name: User3
                        username: user3
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '1 day'
                        lastSeen: '2025-02-10T17:50:30+00:00'
                        canReport: false
                      -
                        view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000004
                        name: User4
                        username: user4
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '4 days'
                        lastSeen: null
                        canReport: false
                      -
                        view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000005
                        name: User5
                        username: user5
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '4 days'
                        lastSeen: null
                        canReport: false
                      -
                        view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000006
                        name: User6
                        username: user6
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '5 days'
                        lastSeen: '2025-02-11T07:21:17+00:00'
                        canReport: false
                      -
                        view: s
                        avatar: ''
                        avatarThumbs: null
                        header: ''
                        headerSize: null
                        headerThumbs: null
                        id: 100000007
                        name: 'Deleted user'
                        username: ''
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 0
                        tipsMinInternal: 0
                        tipsMax: 0
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: null
                        isDeleted: true
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: null
                        subscribedOnExpiredNow: null
                        subscribedOnDuration: null
                        lastSeen: '2025-02-06T04:22:08+00:00'
                        canReport: false
                      -
                        view: s
                        avatar: 'https://example.com/avatar8.jpg'
                        avatarThumbs:
                          c50: 'https://example.com/avatar8_thumb50.jpg'
                          c144: 'https://example.com/avatar8_thumb144.jpg'
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000008
                        name: User8
                        username: user8
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '6 days'
                        lastSeen: '2025-02-07T18:57:15+00:00'
                        canReport: false
                      -
                        view: s
                        avatar: null
                        avatarThumbs: null
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000009
                        name: User9
                        username: user9
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '9 days'
                        lastSeen: null
                        canReport: false
                      -
                        view: s
                        avatar: 'https://example.com/avatar10.jpg'
                        avatarThumbs:
                          c50: 'https://example.com/avatar10_thumb50.jpg'
                          c144: 'https://example.com/avatar10_thumb144.jpg'
                        header: null
                        headerSize: null
                        headerThumbs: null
                        id: 100000010
                        name: User10
                        username: user10
                        canLookStory: false
                        canCommentStory: false
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: false
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: false
                        subscribedByExpire: null
                        subscribedByExpireDate: null
                        subscribedByAutoprolong: null
                        subscribedIsExpiredNow: null
                        currentSubscribePrice: null
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '17 days'
                        lastSeen: '2025-01-25T03:45:20+00:00'
                        canReport: false
                    marker: 1739279385
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 9990
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: s
                            avatar: 'https://example.com/avatar1.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar1_thumb50.jpg'
                              c144: 'https://example.com/avatar1_thumb144.jpg'
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000001
                            name: User1
                            username: user1
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: ''
                            lastSeen: null
                            canReport: false
                          -
                            view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000002
                            name: User2
                            username: user2
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: ''
                            lastSeen: '2025-02-10T19:35:01+00:00'
                            canReport: false
                          -
                            view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000003
                            name: User3
                            username: user3
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '1 day'
                            lastSeen: '2025-02-10T17:50:30+00:00'
                            canReport: false
                          -
                            view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000004
                            name: User4
                            username: user4
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '4 days'
                            lastSeen: null
                            canReport: false
                          -
                            view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000005
                            name: User5
                            username: user5
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '4 days'
                            lastSeen: null
                            canReport: false
                          -
                            view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000006
                            name: User6
                            username: user6
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '5 days'
                            lastSeen: '2025-02-11T07:21:17+00:00'
                            canReport: false
                          -
                            view: s
                            avatar: ''
                            avatarThumbs: null
                            header: ''
                            headerSize: null
                            headerThumbs: null
                            id: 100000007
                            name: 'Deleted user'
                            username: ''
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 0
                            tipsMinInternal: 0
                            tipsMax: 0
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: null
                            isDeleted: true
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: null
                            subscribedOnExpiredNow: null
                            subscribedOnDuration: null
                            lastSeen: '2025-02-06T04:22:08+00:00'
                            canReport: false
                          -
                            view: s
                            avatar: 'https://example.com/avatar8.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar8_thumb50.jpg'
                              c144: 'https://example.com/avatar8_thumb144.jpg'
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000008
                            name: User8
                            username: user8
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '6 days'
                            lastSeen: '2025-02-07T18:57:15+00:00'
                            canReport: false
                          -
                            view: s
                            avatar: null
                            avatarThumbs: null
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000009
                            name: User9
                            username: user9
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '9 days'
                            lastSeen: null
                            canReport: false
                          -
                            view: s
                            avatar: 'https://example.com/avatar10.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar10_thumb50.jpg'
                              c144: 'https://example.com/avatar10_thumb144.jpg'
                            header: null
                            headerSize: null
                            headerThumbs: null
                            id: 100000010
                            name: User10
                            username: user10
                            canLookStory: false
                            canCommentStory: false
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: false
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: false
                            subscribedByExpire: null
                            subscribedByExpireDate: null
                            subscribedByAutoprolong: null
                            subscribedIsExpiredNow: null
                            currentSubscribePrice: null
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '17 days'
                            lastSeen: '2025-01-25T03:45:20+00:00'
                            canReport: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: s
                            avatar:
                              type: string
                              example: 'https://example.com/avatar1.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://example.com/avatar1_thumb50.jpg'
                                c144:
                                  type: string
                                  example: 'https://example.com/avatar1_thumb144.jpg'
                            header:
                              type: string
                              example: null
                            headerSize:
                              type: string
                              example: null
                            headerThumbs:
                              type: string
                              example: null
                            id:
                              type: integer
                              example: 100000001
                            name:
                              type: string
                              example: User1
                            username:
                              type: string
                              example: user1
                            canLookStory:
                              type: boolean
                              example: false
                            canCommentStory:
                              type: boolean
                              example: false
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: false
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: false
                            subscribedByExpire:
                              type: string
                              example: null
                            subscribedByExpireDate:
                              type: string
                              example: null
                            subscribedByAutoprolong:
                              type: string
                              example: null
                            subscribedIsExpiredNow:
                              type: string
                              example: null
                            currentSubscribePrice:
                              type: string
                              example: null
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: ''
                            lastSeen:
                              type: string
                              example: null
                            canReport:
                              type: boolean
                              example: false
                      marker:
                        type: integer
                        example: 1739279385
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9990
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - 'Tracking Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: tracking_link_id
        description: 'The ID of the Tracking Link. Can be retrieved from the above store and list endpoints.'
        example: 1234567890
        required: true
        schema:
          type: string
  '/api/{account}/tracking-links/{tracking_link_id}/spenders':
    get:
      summary: 'List Tracking Link Spenders'
      operationId: listTrackingLinkSpenders
      description: 'Get list of spenders who made purchases through a Tracking Link'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of spenders to return per page. Default `50`.'
          example: 50
          required: false
          schema:
            type: integer
            description: 'The number of spenders to return per page. Default `50`.'
            example: 50
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`.'
            example: 0
        -
          in: query
          name: minSpend
          description: 'Minimal spend of a fan. Default `1`. Must be at least 1.'
          example: 1.0
          required: false
          schema:
            type: number
            description: 'Minimal spend of a fan. Default `1`. Must be at least 1.'
            example: 1.0
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      onlyfans_id: '100000001'
                      username: user_001
                      revenue:
                        total: 26.8
                        calculated_at: '2025-09-29T10:47:19.000000Z'
                    -
                      onlyfans_id: '100000002'
                      username: user_002
                      revenue:
                        total: 109.88
                        calculated_at: '2025-09-29T10:47:19.000000Z'
                    -
                      onlyfans_id: '100000003'
                      username: user_003
                      revenue:
                        total: 32.96
                        calculated_at: '2025-09-29T10:47:19.000000Z'
                  _meta:
                    _credits:
                      used: 1
                      balance: 224802
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 994
                      remaining_day: 49929
                properties:
                  data:
                    type: array
                    example:
                      -
                        onlyfans_id: '100000001'
                        username: user_001
                        revenue:
                          total: 26.8
                          calculated_at: '2025-09-29T10:47:19.000000Z'
                      -
                        onlyfans_id: '100000002'
                        username: user_002
                        revenue:
                          total: 109.88
                          calculated_at: '2025-09-29T10:47:19.000000Z'
                      -
                        onlyfans_id: '100000003'
                        username: user_003
                        revenue:
                          total: 32.96
                          calculated_at: '2025-09-29T10:47:19.000000Z'
                    items:
                      type: object
                      properties:
                        onlyfans_id:
                          type: string
                          example: '100000001'
                        username:
                          type: string
                          example: user_001
                        revenue:
                          type: object
                          properties:
                            total:
                              type: number
                              example: 26.8
                            calculated_at:
                              type: string
                              example: '2025-09-29T10:47:19.000000Z'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224802
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 994
                          remaining_day:
                            type: integer
                            example: 49929
      tags:
        - 'Tracking Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: tracking_link_id
        description: 'The ID of the Tracking Link. Can be retrieved from the above store and list endpoints.'
        example: 1234567890
        required: true
        schema:
          type: string
  '/api/{account}/tracking-links/{tracking_link_id}/stats':
    get:
      summary: 'Get Tracking Link Stats'
      operationId: getTrackingLinkStats
      description: 'Get dashboard-style summary plus daily and monthly metrics for a specific Tracking Link'
      parameters:
        -
          in: query
          name: date_start
          description: 'Optional stats range start date'
          example: '2026-01-01T00:00:00Z'
          required: false
          schema:
            type: string
            description: 'Optional stats range start date'
            example: '2026-01-01T00:00:00Z'
        -
          in: query
          name: date_end
          description: 'Optional stats range end date'
          example: '2026-01-31T23:59:59Z'
          required: false
          schema:
            type: string
            description: 'Optional stats range end date'
            example: '2026-01-31T23:59:59Z'
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    summary:
                      clicks_total: 320
                      subs_total: 80
                      revenue_total: 240.5
                      spenders_total: 22
                      revenue_cached_at: '2026-01-31T23:59:59+00:00'
                    daily_metrics:
                      -
                        timestamp: '2026-01-30'
                        clicks: 12
                        subs: 2
                        revenue: 9.5
                        spenders: 1
                      -
                        timestamp: '2026-01-31'
                        clicks: 17
                        subs: 3
                        revenue: 14.0
                        spenders: 2
                    monthly_metrics:
                      -
                        timestamp: '2026-01-01'
                        clicks: 320
                        subs: 80
                        revenue: 240.5
                        spenders: 22
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                properties:
                  data:
                    type: object
                    properties:
                      summary:
                        type: object
                        properties:
                          clicks_total:
                            type: integer
                            example: 320
                          subs_total:
                            type: integer
                            example: 80
                          revenue_total:
                            type: number
                            example: 240.5
                          spenders_total:
                            type: integer
                            example: 22
                          revenue_cached_at:
                            type: string
                            example: '2026-01-31T23:59:59+00:00'
                      daily_metrics:
                        type: array
                        example:
                          -
                            timestamp: '2026-01-30'
                            clicks: 12
                            subs: 2
                            revenue: 9.5
                            spenders: 1
                          -
                            timestamp: '2026-01-31'
                            clicks: 17
                            subs: 3
                            revenue: 14
                            spenders: 2
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: '2026-01-30'
                            clicks:
                              type: integer
                              example: 12
                            subs:
                              type: integer
                              example: 2
                            revenue:
                              type: number
                              example: 9.5
                            spenders:
                              type: integer
                              example: 1
                      monthly_metrics:
                        type: array
                        example:
                          -
                            timestamp: '2026-01-01'
                            clicks: 320
                            subs: 80
                            revenue: 240.5
                            spenders: 22
                        items:
                          type: object
                          properties:
                            timestamp:
                              type: string
                              example: '2026-01-01'
                            clicks:
                              type: integer
                              example: 320
                            subs:
                              type: integer
                              example: 80
                            revenue:
                              type: number
                              example: 240.5
                            spenders:
                              type: integer
                              example: 22
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
      tags:
        - 'Tracking Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: tracking_link_id
        description: 'The ID of the tracking link.'
        example: quis
        required: true
        schema:
          type: string
  '/api/{account}/tracking-links/{tracking_link_id}/cohort-arps':
    get:
      summary: 'Get Tracking Link Cohort ARPS'
      operationId: getTrackingLinkCohortARPS
      description: 'Get per-link time-to-profit cohort ARPS windows for a specific Tracking Link'
      parameters:
        -
          in: query
          name: acquisition_start
          description: 'Optional acquisition range start date'
          example: '2026-01-01T00:00:00Z'
          required: false
          schema:
            type: string
            description: 'Optional acquisition range start date'
            example: '2026-01-01T00:00:00Z'
        -
          in: query
          name: acquisition_end
          description: 'Optional acquisition range end date'
          example: '2026-01-31T23:59:59Z'
          required: false
          schema:
            type: string
            description: 'Optional acquisition range end date'
            example: '2026-01-31T23:59:59Z'
        -
          in: query
          name: revenue_basis
          description: 'Revenue basis. Defaults to `net`.'
          example: net
          required: false
          schema:
            type: string
            description: 'Revenue basis. Defaults to `net`.'
            example: net
            enum:
              - net
              - gross
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  error: 'Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API key.'
                properties:
                  error:
                    type: string
                    example: 'Unauthorized. Go to https://app.onlyfansapi.com/api-keys to get your API key.'
      tags:
        - 'Tracking Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: tracking_link_id
        description: 'The ID of the tracking link.'
        example: dolorum
        required: true
        schema:
          type: string
  '/api/{account}/tracking-links/{tracking_link_id}/tags':
    get:
      summary: 'List Tracking Link Tags'
      operationId: listTrackingLinkTags
      description: 'Get tags for a specific tracking link. This is a free endpoint.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: 'Free endpoint'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: 'Free endpoint'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
      tags:
        - 'Tracking Links'
    post:
      summary: 'Add Tracking Link Tags'
      operationId: addTrackingLinkTags
      description: 'Add tags to a specific tracking link. Existing tags are preserved. This is a free endpoint.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Instagram
                      - Twitter
                      - TikTok
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: 'Free endpoint'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                          - TikTok
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: 'Free endpoint'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
      tags:
        - 'Tracking Links'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: 'Array of tag names to add to the tracking link.'
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
              required:
                - tags
    delete:
      summary: 'Remove Tracking Link Tags'
      operationId: removeTrackingLinkTags
      description: 'Remove tags from a specific tracking link. This is a free endpoint.'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    tags:
                      - Twitter
                  _meta:
                    _credits:
                      used: 0
                      balance: 9529
                      note: 'Free endpoint'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                properties:
                  data:
                    type: object
                    properties:
                      tags:
                        type: array
                        example:
                          - Twitter
                        items:
                          type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: 'Free endpoint'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
      tags:
        - 'Tracking Links'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: 'Array of tag names to remove from the tracking link.'
                  example: '["Instagram"]'
                  items:
                    type: string
              required:
                - tags
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: tracking_link_id
        description: 'The ID of the tracking link'
        example: 123456789
        required: true
        schema:
          type: integer
  '/api/{account}/tracking-links':
    get:
      summary: 'List Tracking Links'
      operationId: listTrackingLinks
      description: 'List all tracking links for the account and revenue data'
      parameters:
        -
          in: query
          name: startDate
          description: 'The start date for Tracking Links. Keep empty to get all.'
          example: '2025-01-01 00:00:00, -30days'
          required: false
          schema:
            type: string
            description: 'The start date for Tracking Links. Keep empty to get all.'
            example: '2025-01-01 00:00:00, -30days'
            nullable: true
        -
          in: query
          name: endDate
          description: 'The end date for Tracking Links. Keep empty to get all.'
          example: '2025-01-01 00:00:00, now'
          required: false
          schema:
            type: string
            description: 'The end date for Tracking Links. Keep empty to get all.'
            example: '2025-01-01 00:00:00, now'
            nullable: true
        -
          in: query
          name: with_deleted
          description: 'Whether or not to include deleted tracking links in the response. Default `false`'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Whether or not to include deleted tracking links in the response. Default `false`'
            example: false
            nullable: true
        -
          in: query
          name: sortby
          description: 'Sort by subscriber count (claims), or creation date'
          example: claims
          required: false
          schema:
            type: string
            description: 'Sort by subscriber count (claims), or creation date'
            example: claims
            enum:
              - claims
              - created_date
            nullable: true
        -
          in: query
          name: sort
          description: 'Sort the results. Default `desc`'
          example: desc
          required: false
          schema:
            type: string
            description: 'Sort the results. Default `desc`'
            example: desc
            enum:
              - desc
              - asc
            nullable: true
        -
          in: query
          name: limit
          description: 'The number of tracking links to return. Default `3`'
          example: 3
          required: false
          schema:
            type: integer
            description: 'The number of tracking links to return. Default `3`'
            example: 3
            nullable: true
        -
          in: query
          name: offset
          description: 'The offset used for pagination. Default `0`'
          example: 0
          required: false
          schema:
            type: integer
            description: 'The offset used for pagination. Default `0`'
            example: 0
            nullable: true
        -
          in: query
          name: synchronous
          description: 'Wait for the revenue data to finish processing, instead of processing in the background. **Will result in longer response times, use with caution**. Default `false`'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Wait for the revenue data to finish processing, instead of processing in the background. **Will result in longer response times, use with caution**. Default `false`'
            example: false
            nullable: true
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        id: 123456
                        campaignCode: 123
                        campaignName: 'Example Campaign - IG Bio SFS'
                        campaignUrl: 'https://onlyfans.com/USERNAME/c123'
                        subscribersCount: 10
                        clicksCount: 100
                        createdAt: '2025-01-01T00:00:00+00:00'
                        endDate: null
                        tags:
                          - Instagram
                          - Twitter
                        revenue:
                          total: 20
                          revenuePerSubscriber: 2
                          revenuePerClick: 0.2
                          spendersCount: 1
                          calculatedAt: '2025-01-01T00:00:00+00:00'
                          isLoading: false
                        links:
                          related:
                            subscribers: 'https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers'
                    hasMore: true
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/tracking-links?offset=3&limit=3'
                  _meta:
                    _credits:
                      used: 1
                      balance: 9529
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49999
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            id: 123456
                            campaignCode: 123
                            campaignName: 'Example Campaign - IG Bio SFS'
                            campaignUrl: 'https://onlyfans.com/USERNAME/c123'
                            subscribersCount: 10
                            clicksCount: 100
                            createdAt: '2025-01-01T00:00:00+00:00'
                            endDate: null
                            tags:
                              - Instagram
                              - Twitter
                            revenue:
                              total: 20
                              revenuePerSubscriber: 2
                              revenuePerClick: 0.2
                              spendersCount: 1
                              calculatedAt: '2025-01-01T00:00:00+00:00'
                              isLoading: false
                            links:
                              related:
                                subscribers: 'https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers'
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123456
                            campaignCode:
                              type: integer
                              example: 123
                            campaignName:
                              type: string
                              example: 'Example Campaign - IG Bio SFS'
                            campaignUrl:
                              type: string
                              example: 'https://onlyfans.com/USERNAME/c123'
                            subscribersCount:
                              type: integer
                              example: 10
                            clicksCount:
                              type: integer
                              example: 100
                            createdAt:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            endDate:
                              type: string
                              example: null
                            tags:
                              type: array
                              example:
                                - Instagram
                                - Twitter
                              items:
                                type: string
                            revenue:
                              type: object
                              properties:
                                total:
                                  type: integer
                                  example: 20
                                revenuePerSubscriber:
                                  type: integer
                                  example: 2
                                revenuePerClick:
                                  type: number
                                  example: 0.2
                                spendersCount:
                                  type: integer
                                  example: 1
                                calculatedAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                isLoading:
                                  type: boolean
                                  example: false
                            links:
                              type: object
                              properties:
                                related:
                                  type: object
                                  properties:
                                    subscribers:
                                      type: string
                                      example: 'https://app.onlyfansapi.com/api/acct_XXXXXXX/tracking-links/123456/subscribers'
                      hasMore:
                        type: boolean
                        example: true
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_XXXXXXXXXXX/tracking-links?offset=3&limit=3'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 9529
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49999
      tags:
        - 'Tracking Links'
    post:
      summary: 'Create Tracking Link'
      operationId: createTrackingLink
      description: 'Create a new Tracking Link for the account'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 123
                      countSubscribers: 0
                      countTransitions: 0
                      campaignCode: 123
                      campaignName: foobar
                      createdAt: '2025-01-01T00:00:00+00:00'
                      endDate: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999985
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999998
                      remaining_day: 49988
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 123
                        countSubscribers: 0
                        countTransitions: 0
                        campaignCode: 123
                        campaignName: foobar
                        createdAt: '2025-01-01T00:00:00+00:00'
                        endDate: null
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        countSubscribers:
                          type: integer
                          example: 0
                        countTransitions:
                          type: integer
                          example: 0
                        campaignCode:
                          type: integer
                          example: 123
                        campaignName:
                          type: string
                          example: foobar
                        createdAt:
                          type: string
                          example: '2025-01-01T00:00:00+00:00'
                        endDate:
                          type: string
                          example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999985
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999998
                          remaining_day:
                            type: integer
                            example: 49988
      tags:
        - 'Tracking Links'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  description: 'Array of tag names to add to the tracking link.'
                  example: '["Instagram", "Twitter"]'
                  items:
                    type: string
                name:
                  type: string
                  description: 'The name of the Tracking Link'
                  example: 'Twitter bio'
              required:
                - name
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/tracking-links/{tracking_link_id}':
    get:
      summary: 'Get Tracking Link'
      operationId: getTrackingLink
      description: "Get individual Tracking Link details and it's revenue data"
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123456
                    campaignCode: 123
                    campaignName: 'Example Campaign - IG Bio SFS'
                    campaignUrl: 'https://onlyfans.com/USERNAME/c123'
                    subscribersCount: null
                    clicksCount: null
                    createdAt: '2025-01-01T00:00:00+00:00'
                    endDate: null
                    tags:
                      - Instagram
                      - Twitter
                    revenue:
                      total: 20
                      revenuePerSubscriber: 2
                      revenuePerClick: 0.2
                      spendersCount: 1
                      calculatedAt: '2025-01-01T00:00:00+00:00'
                      isLoading: false
                    links:
                      related:
                        subscribers: 'http://ofapi.test/api/acct_XXXXXXXX/tracking-links/123456/subscribers'
                        spenders: 'http://ofapi.test/api/acct_XXXXXXXX/tracking-links/123456/spenders'
                  _meta:
                    _credits:
                      used: 1
                      balance: 7095558
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123456
                      campaignCode:
                        type: integer
                        example: 123
                      campaignName:
                        type: string
                        example: 'Example Campaign - IG Bio SFS'
                      campaignUrl:
                        type: string
                        example: 'https://onlyfans.com/USERNAME/c123'
                      subscribersCount:
                        type: string
                        example: null
                      clicksCount:
                        type: string
                        example: null
                      createdAt:
                        type: string
                        example: '2025-01-01T00:00:00+00:00'
                      endDate:
                        type: string
                        example: null
                      tags:
                        type: array
                        example:
                          - Instagram
                          - Twitter
                        items:
                          type: string
                      revenue:
                        type: object
                        properties:
                          total:
                            type: integer
                            example: 20
                          revenuePerSubscriber:
                            type: integer
                            example: 2
                          revenuePerClick:
                            type: number
                            example: 0.2
                          spendersCount:
                            type: integer
                            example: 1
                          calculatedAt:
                            type: string
                            example: '2025-01-01T00:00:00+00:00'
                          isLoading:
                            type: boolean
                            example: false
                      links:
                        type: object
                        properties:
                          related:
                            type: object
                            properties:
                              subscribers:
                                type: string
                                example: 'http://ofapi.test/api/acct_XXXXXXXX/tracking-links/123456/subscribers'
                              spenders:
                                type: string
                                example: 'http://ofapi.test/api/acct_XXXXXXXX/tracking-links/123456/spenders'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 7095558
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'Tracking Links'
    delete:
      summary: 'Delete Tracking Link'
      operationId: deleteTrackingLink
      description: 'Delete a Tracking Link'
      parameters: []
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999986
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999997
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999986
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999997
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - 'Tracking Links'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: tracking_link_id
        description: 'The ID of the tracking link.'
        example: magni
        required: true
        schema:
          type: string
  '/api/{account}/transactions':
    get:
      summary: 'List Transactions'
      operationId: listTransactions
      description: 'Get a paginated list of transactions for an Account. Newest transactions are first. You can filter by transaction type and tips source.'
      parameters:
        -
          in: query
          name: limit
          description: 'The number of transactions to return. Recommended: `10`'
          example: 10
          required: false
          schema:
            type: string
            description: 'The number of transactions to return. Recommended: `10`'
            example: 10
        -
          in: query
          name: startDate
          description: 'The start date for transactions list. Default: `-30days`'
          example: '2025-01-01 00:00:00, -30days'
          required: false
          schema:
            type: string
            description: 'The start date for transactions list. Default: `-30days`'
            example: '2025-01-01 00:00:00, -30days'
        -
          in: query
          name: marker
          description: 'The marker used for pagination. Default: `null`'
          example: '1739155047'
          required: false
          schema:
            type: string
            description: 'The marker used for pagination. Default: `null`'
            example: '1739155047'
        -
          in: query
          name: type
          description: 'Filter by transaction type. Options: `subscribes`, `tips`, `post`, `chat_messages`, `stream`'
          example: tips
          required: false
          schema:
            type: string
            description: 'Filter by transaction type. Options: `subscribes`, `tips`, `post`, `chat_messages`, `stream`'
            example: tips
        -
          in: query
          name: tipsSource
          description: 'Filter tips by source. Only applies when `type=tips`. Options: `profile`, `post_all`, `chat`, `stream`, `story`'
          example: post_all
          required: false
          schema:
            type: string
            description: 'Filter tips by source. Only applies when `type=tips`. Options: `profile`, `post_all`, `chat`, `stream`, `story`'
            example: post_all
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        amount: 19.99
                        vatAmount: 0
                        taxAmount: 0
                        net: 15.99
                        fee: 4
                        createdAt: '2025-02-10T02:51:22+00:00'
                        currency: USD
                        description: 'Payment for message from <a href="https://onlyfans.com/XXXXXXXX">XXXXXXXX</a>'
                        status: loading
                        user:
                          view: t
                          id: 123123123
                          name: 'Michael XXXXXXXX'
                          username: u123123123
                          isVerified: false
                          avatar: 'https://public.onlyfans.com/files/XXXXXXXXXX.jpg'
                          avatarThumbs:
                            c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/XXXXXXXXXX.jpg'
                            c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/XXXXXXXXXX.jpg'
                        payoutPendingDays: 7
                        id: 5XXXXXXXXXaa1aXXXXXXXXXXX
                    marker: 1739156703
                    hasMore: true
                    nextMarker: 1739155047
                  _pagination:
                    next_page: 'https://app.onlyfansapi.com/api/acct_XXXXXXXX/transactions?startDate=-30days&marker=1739155047&'
                  _meta:
                    _credits:
                      used: 1
                      balance: 34
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 990
                      remaining_day: 49977
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            amount: 19.99
                            vatAmount: 0
                            taxAmount: 0
                            net: 15.99
                            fee: 4
                            createdAt: '2025-02-10T02:51:22+00:00'
                            currency: USD
                            description: 'Payment for message from <a href="https://onlyfans.com/XXXXXXXX">XXXXXXXX</a>'
                            status: loading
                            user:
                              view: t
                              id: 123123123
                              name: 'Michael XXXXXXXX'
                              username: u123123123
                              isVerified: false
                              avatar: 'https://public.onlyfans.com/files/XXXXXXXXXX.jpg'
                              avatarThumbs:
                                c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/XXXXXXXXXX.jpg'
                                c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/XXXXXXXXXX.jpg'
                            payoutPendingDays: 7
                            id: 5XXXXXXXXXaa1aXXXXXXXXXXX
                        items:
                          type: object
                          properties:
                            amount:
                              type: number
                              example: 19.99
                            vatAmount:
                              type: integer
                              example: 0
                            taxAmount:
                              type: integer
                              example: 0
                            net:
                              type: number
                              example: 15.99
                            fee:
                              type: integer
                              example: 4
                            createdAt:
                              type: string
                              example: '2025-02-10T02:51:22+00:00'
                            currency:
                              type: string
                              example: USD
                            description:
                              type: string
                              example: 'Payment for message from <a href="https://onlyfans.com/XXXXXXXX">XXXXXXXX</a>'
                            status:
                              type: string
                              example: loading
                            user:
                              type: object
                              properties:
                                view:
                                  type: string
                                  example: t
                                id:
                                  type: integer
                                  example: 123123123
                                name:
                                  type: string
                                  example: 'Michael XXXXXXXX'
                                username:
                                  type: string
                                  example: u123123123
                                isVerified:
                                  type: boolean
                                  example: false
                                avatar:
                                  type: string
                                  example: 'https://public.onlyfans.com/files/XXXXXXXXXX.jpg'
                                avatarThumbs:
                                  type: object
                                  properties:
                                    c50:
                                      type: string
                                      example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/XXXXXXXXXX.jpg'
                                    c144:
                                      type: string
                                      example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/XXXXXXXXXX.jpg'
                            payoutPendingDays:
                              type: integer
                              example: 7
                            id:
                              type: string
                              example: 5XXXXXXXXXaa1aXXXXXXXXXXX
                      marker:
                        type: integer
                        example: 1739156703
                      hasMore:
                        type: boolean
                        example: true
                      nextMarker:
                        type: integer
                        example: 1739155047
                  _pagination:
                    type: object
                    properties:
                      next_page:
                        type: string
                        example: 'https://app.onlyfansapi.com/api/acct_XXXXXXXX/transactions?startDate=-30days&marker=1739155047&'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 34
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 990
                          remaining_day:
                            type: integer
                            example: 49977
      tags:
        - Transactions
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/user-lists':
    get:
      summary: 'List User Lists'
      operationId: listUserLists
      description: 'Get a list of OnlyFans Collections - User Lists'
      parameters:
        -
          in: query
          name: limit
          description: 'How many results to return in the request. Max. 50 user lists. Must be at least 10. Must not be greater than 50.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'How many results to return in the request. Max. 50 user lists. Must be at least 10. Must not be greater than 50.'
            example: 10
            nullable: true
        -
          in: query
          name: offset
          description: 'Must be at least 0.'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Must be at least 0.'
            example: 0
            nullable: true
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: recent
                      type: recent
                      name: 'Recent (last 24 hours)'
                      usersCount: 0
                      postsCount: 362
                      order: default
                      direction: asc
                      canUpdate: false
                      canDelete: false
                      canManageUsers: false
                      canAddUsers: false
                      canPinnedToFeed: false
                      isPinnedToFeed: false
                      canPinnedToChat: false
                      isPinnedToChat: false
                      sortList: []
                      users: []
                    -
                      id: following
                      type: following
                      name: Following
                      usersCount: 1565
                      postsCount: 302925
                      order: last_activity
                      direction: desc
                      canUpdate: false
                      canDelete: false
                      canManageUsers: false
                      canAddUsers: false
                      canPinnedToFeed: false
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList:
                        expired:
                          order: is_expired
                          direction: desc
                      users:
                        -
                          view: t
                          id: 13760776
                          name: 'User 1'
                          username: user001
                          isVerified: true
                          avatar: null
                          avatarThumbs: null
                        -
                          view: t
                          id: 20385509
                          name: 'User 2'
                          username: user002
                          isVerified: true
                          avatar: null
                          avatarThumbs: null
                        -
                          view: t
                          id: 21272634
                          name: 'User 3'
                          username: user003
                          isVerified: true
                          avatar: null
                          avatarThumbs: null
                    -
                      id: 1139401260
                      type: custom
                      name: 'Test List'
                      usersCount: 7
                      postsCount: 0
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users:
                        -
                          view: t
                          id: 90986491
                          name: 'User 4'
                          username: user004
                          isVerified: false
                          avatar: 'https://example.com/avatar1.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar1_c50.jpg'
                            c144: 'https://example.com/avatar1_c144.jpg'
                        -
                          view: t
                          id: 179686216
                          name: 'User 5'
                          username: user005
                          isVerified: false
                          avatar: null
                          avatarThumbs: null
                        -
                          view: t
                          id: 215265232
                          name: 'User 6'
                          username: user006
                          isVerified: false
                          avatar: null
                          avatarThumbs: null
                    -
                      id: 1015359034
                      type: custom
                      name: 'Sample List'
                      usersCount: 1
                      postsCount: 29
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users:
                        -
                          view: t
                          id: 254
                          name: 'Official Account'
                          username: official_account
                          isVerified: true
                          avatar: 'https://example.com/official_avatar.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/official_avatar_c50.jpg'
                            c144: 'https://example.com/official_avatar_c144.jpg'
                    -
                      id: 1196977344
                      type: custom
                      name: 'Custom List 1'
                      usersCount: 3
                      postsCount: 10
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users:
                        -
                          view: t
                          id: 501222911
                          name: 'User 7'
                          username: user007
                          isVerified: true
                          avatar: 'https://example.com/avatar2.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar2_c50.jpg'
                            c144: 'https://example.com/avatar2_c144.jpg'
                        -
                          view: t
                          id: 501239164
                          name: 'User 8'
                          username: user008
                          isVerified: true
                          avatar: null
                          avatarThumbs: null
                        -
                          view: t
                          id: 501239274
                          name: 'User 9'
                          username: user009
                          isVerified: true
                          avatar: 'https://example.com/avatar3.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar3_c50.jpg'
                            c144: 'https://example.com/avatar3_c144.jpg'
                    -
                      id: 1030408500
                      type: custom
                      name: 'Custom List 2'
                      usersCount: 3
                      postsCount: 253
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users:
                        -
                          view: t
                          id: 11317639
                          name: 'User 10'
                          username: user010
                          isVerified: false
                          avatar: null
                          avatarThumbs: null
                        -
                          view: t
                          id: 333848388
                          name: 'User 11'
                          username: user011
                          isVerified: false
                          avatar: null
                          avatarThumbs: null
                        -
                          view: t
                          id: 343871698
                          name: 'User 12'
                          username: user012
                          isVerified: true
                          avatar: 'https://example.com/avatar4.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar4_c50.jpg'
                            c144: 'https://example.com/avatar4_c144.jpg'
                    -
                      id: 1197226753
                      type: custom
                      name: 'Custom List 3'
                      usersCount: 3
                      postsCount: 2
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users:
                        -
                          view: t
                          id: 501239695
                          name: 'User 13'
                          username: user013
                          isVerified: true
                          avatar: 'https://example.com/avatar5.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar5_c50.jpg'
                            c144: 'https://example.com/avatar5_c144.jpg'
                        -
                          view: t
                          id: 501239827
                          name: 'User 14'
                          username: user014
                          isVerified: true
                          avatar: 'https://example.com/avatar6.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar6_c50.jpg'
                            c144: 'https://example.com/avatar6_c144.jpg'
                        -
                          view: t
                          id: 501240489
                          name: 'User 15'
                          username: user015
                          isVerified: true
                          avatar: 'https://example.com/avatar7.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar7_c50.jpg'
                            c144: 'https://example.com/avatar7_c144.jpg'
                    -
                      id: 1197228713
                      type: custom
                      name: 'Empty List'
                      usersCount: 0
                      postsCount: 0
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users: []
                    -
                      id: 1015361366
                      type: custom
                      name: 'Custom List 4'
                      usersCount: 4
                      postsCount: 0
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users:
                        -
                          view: t
                          id: 234451987
                          name: 'User 16'
                          username: user016
                          isVerified: false
                          avatar: 'https://example.com/avatar8.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar8_c50.jpg'
                            c144: 'https://example.com/avatar8_c144.jpg'
                        -
                          view: t
                          id: 240164795
                          name: 'User 17'
                          username: user017
                          isVerified: false
                          avatar: 'https://example.com/avatar9.jpg'
                          avatarThumbs:
                            c50: 'https://example.com/avatar9_c50.jpg'
                            c144: 'https://example.com/avatar9_c144.jpg'
                        -
                          view: t
                          id: 279118217
                          name: 'User 18'
                          username: user018
                          isVerified: false
                          avatar: null
                          avatarThumbs: null
                    -
                      id: 1015359887
                      type: custom
                      name: 'Another Empty List'
                      usersCount: 0
                      postsCount: 0
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 224858
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49991
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        usersCount: 0
                        postsCount: 362
                        order: default
                        direction: asc
                        canUpdate: false
                        canDelete: false
                        canManageUsers: false
                        canAddUsers: false
                        canPinnedToFeed: false
                        isPinnedToFeed: false
                        canPinnedToChat: false
                        isPinnedToChat: false
                        sortList: []
                        users: []
                      -
                        id: following
                        type: following
                        name: Following
                        usersCount: 1565
                        postsCount: 302925
                        order: last_activity
                        direction: desc
                        canUpdate: false
                        canDelete: false
                        canManageUsers: false
                        canAddUsers: false
                        canPinnedToFeed: false
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList:
                          expired:
                            order: is_expired
                            direction: desc
                        users:
                          -
                            view: t
                            id: 13760776
                            name: 'User 1'
                            username: user001
                            isVerified: true
                            avatar: null
                            avatarThumbs: null
                          -
                            view: t
                            id: 20385509
                            name: 'User 2'
                            username: user002
                            isVerified: true
                            avatar: null
                            avatarThumbs: null
                          -
                            view: t
                            id: 21272634
                            name: 'User 3'
                            username: user003
                            isVerified: true
                            avatar: null
                            avatarThumbs: null
                      -
                        id: 1139401260
                        type: custom
                        name: 'Test List'
                        usersCount: 7
                        postsCount: 0
                        order: default
                        direction: asc
                        canUpdate: true
                        canDelete: true
                        canManageUsers: true
                        canAddUsers: true
                        canPinnedToFeed: true
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList: []
                        users:
                          -
                            view: t
                            id: 90986491
                            name: 'User 4'
                            username: user004
                            isVerified: false
                            avatar: 'https://example.com/avatar1.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar1_c50.jpg'
                              c144: 'https://example.com/avatar1_c144.jpg'
                          -
                            view: t
                            id: 179686216
                            name: 'User 5'
                            username: user005
                            isVerified: false
                            avatar: null
                            avatarThumbs: null
                          -
                            view: t
                            id: 215265232
                            name: 'User 6'
                            username: user006
                            isVerified: false
                            avatar: null
                            avatarThumbs: null
                      -
                        id: 1015359034
                        type: custom
                        name: 'Sample List'
                        usersCount: 1
                        postsCount: 29
                        order: default
                        direction: asc
                        canUpdate: true
                        canDelete: true
                        canManageUsers: true
                        canAddUsers: true
                        canPinnedToFeed: true
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList: []
                        users:
                          -
                            view: t
                            id: 254
                            name: 'Official Account'
                            username: official_account
                            isVerified: true
                            avatar: 'https://example.com/official_avatar.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/official_avatar_c50.jpg'
                              c144: 'https://example.com/official_avatar_c144.jpg'
                      -
                        id: 1196977344
                        type: custom
                        name: 'Custom List 1'
                        usersCount: 3
                        postsCount: 10
                        order: default
                        direction: asc
                        canUpdate: true
                        canDelete: true
                        canManageUsers: true
                        canAddUsers: true
                        canPinnedToFeed: true
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList: []
                        users:
                          -
                            view: t
                            id: 501222911
                            name: 'User 7'
                            username: user007
                            isVerified: true
                            avatar: 'https://example.com/avatar2.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar2_c50.jpg'
                              c144: 'https://example.com/avatar2_c144.jpg'
                          -
                            view: t
                            id: 501239164
                            name: 'User 8'
                            username: user008
                            isVerified: true
                            avatar: null
                            avatarThumbs: null
                          -
                            view: t
                            id: 501239274
                            name: 'User 9'
                            username: user009
                            isVerified: true
                            avatar: 'https://example.com/avatar3.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar3_c50.jpg'
                              c144: 'https://example.com/avatar3_c144.jpg'
                      -
                        id: 1030408500
                        type: custom
                        name: 'Custom List 2'
                        usersCount: 3
                        postsCount: 253
                        order: default
                        direction: asc
                        canUpdate: true
                        canDelete: true
                        canManageUsers: true
                        canAddUsers: true
                        canPinnedToFeed: true
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList: []
                        users:
                          -
                            view: t
                            id: 11317639
                            name: 'User 10'
                            username: user010
                            isVerified: false
                            avatar: null
                            avatarThumbs: null
                          -
                            view: t
                            id: 333848388
                            name: 'User 11'
                            username: user011
                            isVerified: false
                            avatar: null
                            avatarThumbs: null
                          -
                            view: t
                            id: 343871698
                            name: 'User 12'
                            username: user012
                            isVerified: true
                            avatar: 'https://example.com/avatar4.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar4_c50.jpg'
                              c144: 'https://example.com/avatar4_c144.jpg'
                      -
                        id: 1197226753
                        type: custom
                        name: 'Custom List 3'
                        usersCount: 3
                        postsCount: 2
                        order: default
                        direction: asc
                        canUpdate: true
                        canDelete: true
                        canManageUsers: true
                        canAddUsers: true
                        canPinnedToFeed: true
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList: []
                        users:
                          -
                            view: t
                            id: 501239695
                            name: 'User 13'
                            username: user013
                            isVerified: true
                            avatar: 'https://example.com/avatar5.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar5_c50.jpg'
                              c144: 'https://example.com/avatar5_c144.jpg'
                          -
                            view: t
                            id: 501239827
                            name: 'User 14'
                            username: user014
                            isVerified: true
                            avatar: 'https://example.com/avatar6.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar6_c50.jpg'
                              c144: 'https://example.com/avatar6_c144.jpg'
                          -
                            view: t
                            id: 501240489
                            name: 'User 15'
                            username: user015
                            isVerified: true
                            avatar: 'https://example.com/avatar7.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar7_c50.jpg'
                              c144: 'https://example.com/avatar7_c144.jpg'
                      -
                        id: 1197228713
                        type: custom
                        name: 'Empty List'
                        usersCount: 0
                        postsCount: 0
                        order: default
                        direction: asc
                        canUpdate: true
                        canDelete: true
                        canManageUsers: true
                        canAddUsers: true
                        canPinnedToFeed: true
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList: []
                        users: []
                      -
                        id: 1015361366
                        type: custom
                        name: 'Custom List 4'
                        usersCount: 4
                        postsCount: 0
                        order: default
                        direction: asc
                        canUpdate: true
                        canDelete: true
                        canManageUsers: true
                        canAddUsers: true
                        canPinnedToFeed: true
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList: []
                        users:
                          -
                            view: t
                            id: 234451987
                            name: 'User 16'
                            username: user016
                            isVerified: false
                            avatar: 'https://example.com/avatar8.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar8_c50.jpg'
                              c144: 'https://example.com/avatar8_c144.jpg'
                          -
                            view: t
                            id: 240164795
                            name: 'User 17'
                            username: user017
                            isVerified: false
                            avatar: 'https://example.com/avatar9.jpg'
                            avatarThumbs:
                              c50: 'https://example.com/avatar9_c50.jpg'
                              c144: 'https://example.com/avatar9_c144.jpg'
                          -
                            view: t
                            id: 279118217
                            name: 'User 18'
                            username: user018
                            isVerified: false
                            avatar: null
                            avatarThumbs: null
                      -
                        id: 1015359887
                        type: custom
                        name: 'Another Empty List'
                        usersCount: 0
                        postsCount: 0
                        order: default
                        direction: asc
                        canUpdate: true
                        canDelete: true
                        canManageUsers: true
                        canAddUsers: true
                        canPinnedToFeed: true
                        isPinnedToFeed: false
                        canPinnedToChat: true
                        isPinnedToChat: false
                        sortList: []
                        users: []
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: recent
                        type:
                          type: string
                          example: recent
                        name:
                          type: string
                          example: 'Recent (last 24 hours)'
                        usersCount:
                          type: integer
                          example: 0
                        postsCount:
                          type: integer
                          example: 362
                        order:
                          type: string
                          example: default
                        direction:
                          type: string
                          example: asc
                        canUpdate:
                          type: boolean
                          example: false
                        canDelete:
                          type: boolean
                          example: false
                        canManageUsers:
                          type: boolean
                          example: false
                        canAddUsers:
                          type: boolean
                          example: false
                        canPinnedToFeed:
                          type: boolean
                          example: false
                        isPinnedToFeed:
                          type: boolean
                          example: false
                        canPinnedToChat:
                          type: boolean
                          example: false
                        isPinnedToChat:
                          type: boolean
                          example: false
                        sortList:
                          type: array
                          example: []
                        users:
                          type: array
                          example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224858
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49991
      tags:
        - 'User List Collections'
    post:
      summary: 'Create User List'
      operationId: createUserList
      description: 'Create a OnlyFans User List'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 1224114714
                    type: custom
                    name: 'test via onlyfansapi'
                    usersCount: 0
                    postsCount: 0
                    order: default
                    direction: asc
                    canUpdate: true
                    canDelete: true
                    canManageUsers: true
                    canAddUsers: true
                    canPinnedToFeed: true
                    isPinnedToFeed: false
                    canPinnedToChat: true
                    isPinnedToChat: false
                    sortList: []
                    users: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 224847
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49980
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1224114714
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'test via onlyfansapi'
                      usersCount:
                        type: integer
                        example: 0
                      postsCount:
                        type: integer
                        example: 0
                      order:
                        type: string
                        example: default
                      direction:
                        type: string
                        example: asc
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      canManageUsers:
                        type: boolean
                        example: true
                      canAddUsers:
                        type: boolean
                        example: true
                      canPinnedToFeed:
                        type: boolean
                        example: true
                      isPinnedToFeed:
                        type: boolean
                        example: false
                      canPinnedToChat:
                        type: boolean
                        example: true
                      isPinnedToChat:
                        type: boolean
                        example: false
                      sortList:
                        type: array
                        example: []
                      users:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224847
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49980
      tags:
        - 'User List Collections'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Must not be greater than 64 characters.'
                  example: lzgfyrvyawrbvn
              required:
                - name
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/user-lists/{userListId}':
    get:
      summary: 'Get User List'
      operationId: getUserList
      description: 'Get a user list'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: 'List name'
                    usersCount: 123
                    postsCount: 123
                    order: default
                    direction: asc
                    canUpdate: true
                    canDelete: true
                    canManageUsers: true
                    canAddUsers: true
                    canPinnedToFeed: true
                    isPinnedToFeed: false
                    canPinnedToChat: true
                    isPinnedToChat: false
                    sortList: []
                    users:
                      -
                        view: t
                        id: 123
                        name: Name
                        username: username
                        isVerified: true
                        avatar: 'https://public.onlyfans.com/files/m/mk/mka/.../avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/m/mk/mka/.../avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/m/mk/mka/.../avatar.jpg'
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999974
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49986
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'List name'
                      usersCount:
                        type: integer
                        example: 123
                      postsCount:
                        type: integer
                        example: 123
                      order:
                        type: string
                        example: default
                      direction:
                        type: string
                        example: asc
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      canManageUsers:
                        type: boolean
                        example: true
                      canAddUsers:
                        type: boolean
                        example: true
                      canPinnedToFeed:
                        type: boolean
                        example: true
                      isPinnedToFeed:
                        type: boolean
                        example: false
                      canPinnedToChat:
                        type: boolean
                        example: true
                      isPinnedToChat:
                        type: boolean
                        example: false
                      sortList:
                        type: array
                        example: []
                      users:
                        type: array
                        example:
                          -
                            view: t
                            id: 123
                            name: Name
                            username: username
                            isVerified: true
                            avatar: 'https://public.onlyfans.com/files/m/mk/mka/.../avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/m/mk/mka/.../avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/m/mk/mka/.../avatar.jpg'
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: t
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: Name
                            username:
                              type: string
                              example: username
                            isVerified:
                              type: boolean
                              example: true
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/m/mk/mka/.../avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/m/mk/mka/.../avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/m/mk/mka/.../avatar.jpg'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999974
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49986
      tags:
        - 'User List Collections'
    put:
      summary: 'Update User List'
      operationId: updateUserList
      description: 'Update a OnlyFans User List'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 1224114714
                    type: custom
                    name: 'updated - test via onlyfansapi'
                    usersCount: 0
                    postsCount: 0
                    order: default
                    direction: asc
                    canUpdate: true
                    canDelete: true
                    canManageUsers: true
                    canAddUsers: true
                    canPinnedToFeed: true
                    isPinnedToFeed: false
                    canPinnedToChat: true
                    isPinnedToChat: false
                    sortList: []
                    users: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 224847
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49980
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1224114714
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'updated - test via onlyfansapi'
                      usersCount:
                        type: integer
                        example: 0
                      postsCount:
                        type: integer
                        example: 0
                      order:
                        type: string
                        example: default
                      direction:
                        type: string
                        example: asc
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      canManageUsers:
                        type: boolean
                        example: true
                      canAddUsers:
                        type: boolean
                        example: true
                      canPinnedToFeed:
                        type: boolean
                        example: true
                      isPinnedToFeed:
                        type: boolean
                        example: false
                      canPinnedToChat:
                        type: boolean
                        example: true
                      isPinnedToChat:
                        type: boolean
                        example: false
                      sortList:
                        type: array
                        example: []
                      users:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224847
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49980
      tags:
        - 'User List Collections'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'The new name for the User List.'
                  example: 'My Updated List Name'
                isPinnedToFeed:
                  type: boolean
                  description: 'Whether to pin the User List to feed to the OnlyFans homepage or not.'
                  example: true
                  nullable: true
              required:
                - name
    delete:
      summary: 'Delete User List'
      operationId: deleteUserList
      description: 'Delete a OnlyFans User List'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 224847
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49980
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224847
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49980
      tags:
        - 'User List Collections'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: userListId
        description: 'OnlyFans User List ID, or a default list name like `tagged`'
        example: 1224114714
        required: true
        schema:
          type: string
  '/api/{account}/user-lists/{userListId}/users':
    get:
      summary: 'List User List Users'
      operationId: listUserListUsers
      description: 'Get all users in a OnlyFans User List'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of users to return (1 - 100). Default = 10'
          example: 10
          required: false
          schema:
            type: string
            description: 'Number of users to return (1 - 100). Default = 10'
            example: 10
        -
          in: query
          name: offset
          description: 'Number of users to skip for pagination'
          example: 0
          required: false
          schema:
            type: string
            description: 'Number of users to skip for pagination'
            example: 0
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                        header: 'https://public.onlyfans.com/files/.../header.jpg'
                        headerSize:
                          width: 2160
                          height: 2700
                        headerThumbs:
                          w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                          w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                        id: 123
                        name: name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '3 days'
                        listsStates:
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: USER_NOT_PERFORMER
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: rebill_off
                            type: rebill_off
                            name: 'Renew Off'
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: rebill_on
                            type: rebill_on
                            name: 'Renew On'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        canReport: true
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: false
                        isRealPerformer: false
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: '2025-01-01T00:00:00+00:00'
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '3 days'
                          showPostsInFeed: true
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 123
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 5
                          subscribePrice: 5
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: 'Set to Expire'
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '3 days'
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 90
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 5
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: '2025-01-01T00:00:00+00:00'
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          -
                            id: 123
                            subscribeDays: 90
                            createdAt: '2025-01-01T00:00:00+00:00'
                            expiredAt: null
                            finishedAt: '2025-01-01T00:00:00+00:00'
                            subscriberId: '123'
                            userId: '123'
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    nextOffset: 3
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999977
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49989
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                            header: 'https://public.onlyfans.com/files/.../header.jpg'
                            headerSize:
                              width: 2160
                              height: 2700
                            headerThumbs:
                              w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                              w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                            id: 123
                            name: name
                            username: username
                            canLookStory: true
                            canCommentStory: true
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '3 days'
                            listsStates:
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: USER_NOT_PERFORMER
                              -
                                id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: recent
                                type: recent
                                name: 'Recent (last 24 hours)'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: rebill_off
                                type: rebill_off
                                name: 'Renew Off'
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: rebill_on
                                type: rebill_on
                                name: 'Renew On'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              -
                                id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                            canReport: true
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: '2025-01-01T00:00:00+00:00'
                            isPerformer: false
                            isRealPerformer: false
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: '2025-01-01T00:00:00+00:00'
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '3 days'
                              showPostsInFeed: true
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 123
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 5
                              subscribePrice: 5
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: 'Set to Expire'
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '3 days'
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: '2025-01-01T00:00:00+00:00'
                              recommendations: 0
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 90
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 5
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: '2025-01-01T00:00:00+00:00'
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              -
                                id: 123
                                subscribeDays: 90
                                createdAt: '2025-01-01T00:00:00+00:00'
                                expiredAt: null
                                finishedAt: '2025-01-01T00:00:00+00:00'
                                subscriberId: '123'
                                userId: '123'
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/.../avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                            header:
                              type: string
                              example: 'https://public.onlyfans.com/files/.../header.jpg'
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 2160
                                height:
                                  type: integer
                                  example: 2700
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                                w760:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: true
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: '3 days'
                            listsStates:
                              type: array
                              example:
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: USER_NOT_PERFORMER
                                -
                                  id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: recent
                                  type: recent
                                  name: 'Recent (last 24 hours)'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: rebill_off
                                  type: rebill_off
                                  name: 'Renew Off'
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: rebill_on
                                  type: rebill_on
                                  name: 'Renew On'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                -
                                  id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: fans
                                  type:
                                    type: string
                                    example: fans
                                  name:
                                    type: string
                                    example: Fans
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: true
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPerformer:
                              type: boolean
                              example: false
                            isRealPerformer:
                              type: boolean
                              example: false
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '3 days'
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 123
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 123 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 0 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: auto }
                                      offerStart: { type: string, example: null }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 5
                                subscribePrice:
                                  type: integer
                                  example: 5
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: 'Set to Expire'
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '3 days'
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 90
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 5
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: '2025-01-01T00:00:00+00:00'
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 90 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 5 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: trial }
                                      offerStart: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                -
                                  id: 123
                                  subscribeDays: 90
                                  createdAt: '2025-01-01T00:00:00+00:00'
                                  expiredAt: null
                                  finishedAt: '2025-01-01T00:00:00+00:00'
                                  subscriberId: '123'
                                  userId: '123'
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 90
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  expiredAt:
                                    type: string
                                    example: null
                                  finishedAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  subscriberId:
                                    type: string
                                    example: '123'
                                  userId:
                                    type: string
                                    example: '123'
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      nextOffset:
                        type: integer
                        example: 3
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999977
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49989
      tags:
        - 'User List Collections'
    post:
      summary: 'Add Users to User List'
      operationId: addUsersToUserList
      description: 'Add multiple Users To OnlyFans User List'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    '1224114714':
                      - 123456
                      - 44112233
                      - 22113344
                  _meta:
                    _credits:
                      used: 1
                      balance: 224745
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49947
                properties:
                  data:
                    type: object
                    properties:
                      1224114714:
                        type: array
                        example:
                          - 123456
                          - 44112233
                          - 22113344
                        items:
                          type: integer
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224745
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49947
        400:
          description: "Usually if the user is already in the list or some of the user ids don't exist. We recommend re-trying the request with the problematic IDs excluded."
          content:
            application/json:
              schema:
                type: object
                example:
                  error: ONLYFANS_COM_ERROR
                  message: 'Bad Request - The request could not be understood by the server.'
                  description: 'This error happened most probably because of a bug in the OnlyFans.com API or you sent wrong parameters (like a non-existing user id).'
                  onlyfans_response:
                    status: 400
                    body:
                      error:
                        code: 0
                        message: 'Unable to add SAMPLE USER to Custom - OFAPI Test'
                      errors:
                        '1224114714':
                          '123456':
                            - 'Unable to add SAMPLE USER to Custom - OFAPI Test'
                  _meta:
                    _credits:
                      used: 1
                      balance: 224744
                      note: 'OnlyFans returned an error, but we still had to make an API request to OnlyFans.com'
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49946
                properties:
                  error:
                    type: string
                    example: ONLYFANS_COM_ERROR
                  message:
                    type: string
                    example: 'Bad Request - The request could not be understood by the server.'
                  description:
                    type: string
                    example: 'This error happened most probably because of a bug in the OnlyFans.com API or you sent wrong parameters (like a non-existing user id).'
                  onlyfans_response:
                    type: object
                    properties:
                      status:
                        type: integer
                        example: 400
                      body:
                        type: object
                        properties:
                          error:
                            type: object
                            properties:
                              code:
                                type: integer
                                example: 0
                              message:
                                type: string
                                example: 'Unable to add SAMPLE USER to Custom - OFAPI Test'
                          errors:
                            type: object
                            properties:
                              1224114714:
                                type: object
                                properties:
                                  123456:
                                    type: array
                                    example:
                                      - 'Unable to add SAMPLE USER to Custom - OFAPI Test'
                                    items:
                                      type: string
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224744
                          note:
                            type: string
                            example: 'OnlyFans returned an error, but we still had to make an API request to OnlyFans.com'
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49946
      tags:
        - 'User List Collections'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: 'Array of OnlyFans User IDs to be added into the list'
                  example:
                    - 123456
                    - 44112233
                    - 22113344
                  items:
                    type: string
              required:
                - ids
    delete:
      summary: 'Clear User List'
      operationId: clearUserList
      description: 'Remove all users from a OnlyFans User List'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 123
                    type: custom
                    name: 'List name'
                    usersCount: 0
                    postsCount: 0
                    order: default
                    direction: asc
                    canUpdate: true
                    canDelete: true
                    canManageUsers: true
                    canAddUsers: true
                    canPinnedToFeed: true
                    isPinnedToFeed: false
                    canPinnedToChat: true
                    isPinnedToChat: false
                    sortList: []
                    users: []
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999873
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49996
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      type:
                        type: string
                        example: custom
                      name:
                        type: string
                        example: 'List name'
                      usersCount:
                        type: integer
                        example: 0
                      postsCount:
                        type: integer
                        example: 0
                      order:
                        type: string
                        example: default
                      direction:
                        type: string
                        example: asc
                      canUpdate:
                        type: boolean
                        example: true
                      canDelete:
                        type: boolean
                        example: true
                      canManageUsers:
                        type: boolean
                        example: true
                      canAddUsers:
                        type: boolean
                        example: true
                      canPinnedToFeed:
                        type: boolean
                        example: true
                      isPinnedToFeed:
                        type: boolean
                        example: false
                      canPinnedToChat:
                        type: boolean
                        example: true
                      isPinnedToChat:
                        type: boolean
                        example: false
                      sortList:
                        type: array
                        example: []
                      users:
                        type: array
                        example: []
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999873
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - 'User List Collections'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: userListId
        description: 'OnlyFans User List ID, or a default list name like `tagged`'
        example: 1224114714
        required: true
        schema:
          type: string
  '/api/{account}/user-lists/{userListId}/users/pinned':
    get:
      summary: 'List Pinned Users in User List'
      operationId: listPinnedUsersInUserList
      description: 'Get pinned users from an OnlyFans User List.'
      parameters:
        -
          in: query
          name: limit
          description: 'Number of users to return (1 - 100). Default = 10'
          example: 10
          required: false
          schema:
            type: string
            description: 'Number of users to return (1 - 100). Default = 10'
            example: 10
        -
          in: query
          name: offset
          description: 'Number of users to skip for pagination'
          example: 0
          required: false
          schema:
            type: string
            description: 'Number of users to skip for pagination'
            example: 0
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      -
                        view: x
                        avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                        avatarThumbs:
                          c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                          c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                        header: 'https://public.onlyfans.com/files/.../header.jpg'
                        headerSize:
                          width: 2160
                          height: 2700
                        headerThumbs:
                          w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                          w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                        id: 123
                        name: name
                        username: username
                        canLookStory: true
                        canCommentStory: true
                        hasNotViewedStory: false
                        isVerified: false
                        canPayInternal: true
                        hasScheduledStream: false
                        hasStream: false
                        hasStories: false
                        tipsEnabled: false
                        tipsTextEnabled: true
                        tipsMin: 5
                        tipsMinInternal: 1
                        tipsMax: 200
                        canEarn: false
                        canAddSubscriber: false
                        subscribePrice: 0
                        displayName: ''
                        notice: ''
                        isRestricted: false
                        canRestrict: true
                        subscribedBy: true
                        subscribedByExpire: false
                        subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                        subscribedByAutoprolong: true
                        subscribedIsExpiredNow: false
                        currentSubscribePrice: 0
                        subscribedOn: true
                        subscribedOnExpiredNow: false
                        subscribedOnDuration: '3 days'
                        listsStates:
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: USER_NOT_PERFORMER
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: rebill_off
                            type: rebill_off
                            name: 'Renew Off'
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: rebill_on
                            type: rebill_on
                            name: 'Renew On'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                        canReport: true
                        canReceiveChatMessage: true
                        hideChat: false
                        lastSeen: '2025-01-01T00:00:00+00:00'
                        isPerformer: false
                        isRealPerformer: false
                        subscribedByData:
                          price: 0
                          newPrice: 0
                          regularPrice: 0
                          subscribePrice: 0
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: '2025-01-01T00:00:00+00:00'
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: null
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '3 days'
                          showPostsInFeed: true
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 123
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 0
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: auto
                              offerStart: null
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        subscribedOnData:
                          price: 0
                          newPrice: 0
                          regularPrice: 5
                          subscribePrice: 5
                          discountPercent: 0
                          discountPeriod: 1
                          subscribeAt: '2025-01-01T00:00:00+00:00'
                          expiredAt: '2025-01-01T00:00:00+00:00'
                          renewedAt: null
                          discountFinishedAt: null
                          discountStartedAt: null
                          status: 'Set to Expire'
                          isMuted: false
                          unsubscribeReason: 'No reason given'
                          duration: '3 days'
                          tipsSumm: 0
                          subscribesSumm: 0
                          messagesSumm: 0
                          postsSumm: 0
                          streamsSumm: 0
                          totalSumm: 0
                          lastActivity: '2025-01-01T00:00:00+00:00'
                          recommendations: 0
                          subscribes:
                            -
                              id: 123
                              userId: 123
                              subscriberId: 123
                              date: '2025-01-01T00:00:00+00:00'
                              duration: 90
                              startDate: '2025-01-01T00:00:00+00:00'
                              expireDate: '2025-01-01T00:00:00+00:00'
                              cancelDate: null
                              price: 0
                              regularPrice: 5
                              discount: 0
                              earningId: 0
                              action: subscribe
                              type: trial
                              offerStart: '2025-01-01T00:00:00+00:00'
                              offerEnd: null
                              isCurrent: true
                          hasActivePaidSubscriptions: false
                        canTrialSend: false
                        isBlocked: false
                        promoOffers:
                          -
                            id: 123
                            subscribeDays: 90
                            createdAt: '2025-01-01T00:00:00+00:00'
                            expiredAt: null
                            finishedAt: '2025-01-01T00:00:00+00:00'
                            subscriberId: '123'
                            userId: '123'
                        canUnsubscribe: true
                        isPendingAutoprolong: false
                    nextOffset: 3
                    hasMore: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999977
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 997
                      remaining_day: 49989
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: array
                        example:
                          -
                            view: x
                            avatar: 'https://public.onlyfans.com/files/.../avatar.jpg'
                            avatarThumbs:
                              c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                              c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                            header: 'https://public.onlyfans.com/files/.../header.jpg'
                            headerSize:
                              width: 2160
                              height: 2700
                            headerThumbs:
                              w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                              w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                            id: 123
                            name: name
                            username: username
                            canLookStory: true
                            canCommentStory: true
                            hasNotViewedStory: false
                            isVerified: false
                            canPayInternal: true
                            hasScheduledStream: false
                            hasStream: false
                            hasStories: false
                            tipsEnabled: false
                            tipsTextEnabled: true
                            tipsMin: 5
                            tipsMinInternal: 1
                            tipsMax: 200
                            canEarn: false
                            canAddSubscriber: false
                            subscribePrice: 0
                            displayName: ''
                            notice: ''
                            isRestricted: false
                            canRestrict: true
                            subscribedBy: true
                            subscribedByExpire: false
                            subscribedByExpireDate: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong: true
                            subscribedIsExpiredNow: false
                            currentSubscribePrice: 0
                            subscribedOn: true
                            subscribedOnExpiredNow: false
                            subscribedOnDuration: '3 days'
                            listsStates:
                              -
                                id: fans
                                type: fans
                                name: Fans
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: following
                                type: following
                                name: Following
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: friends
                                type: friends
                                name: Friends
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: USER_NOT_PERFORMER
                              -
                                id: muted
                                type: muted
                                name: Muted
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: recent
                                type: recent
                                name: 'Recent (last 24 hours)'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: rebill_off
                                type: rebill_off
                                name: 'Renew Off'
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: rebill_on
                                type: rebill_on
                                name: 'Renew On'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              -
                                id: tagged
                                type: tagged
                                name: Tagged
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                            canReport: true
                            canReceiveChatMessage: true
                            hideChat: false
                            lastSeen: '2025-01-01T00:00:00+00:00'
                            isPerformer: false
                            isRealPerformer: false
                            subscribedByData:
                              price: 0
                              newPrice: 0
                              regularPrice: 0
                              subscribePrice: 0
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: '2025-01-01T00:00:00+00:00'
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: null
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '3 days'
                              showPostsInFeed: true
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 123
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 0
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: auto
                                  offerStart: null
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            subscribedOnData:
                              price: 0
                              newPrice: 0
                              regularPrice: 5
                              subscribePrice: 5
                              discountPercent: 0
                              discountPeriod: 1
                              subscribeAt: '2025-01-01T00:00:00+00:00'
                              expiredAt: '2025-01-01T00:00:00+00:00'
                              renewedAt: null
                              discountFinishedAt: null
                              discountStartedAt: null
                              status: 'Set to Expire'
                              isMuted: false
                              unsubscribeReason: 'No reason given'
                              duration: '3 days'
                              tipsSumm: 0
                              subscribesSumm: 0
                              messagesSumm: 0
                              postsSumm: 0
                              streamsSumm: 0
                              totalSumm: 0
                              lastActivity: '2025-01-01T00:00:00+00:00'
                              recommendations: 0
                              subscribes:
                                -
                                  id: 123
                                  userId: 123
                                  subscriberId: 123
                                  date: '2025-01-01T00:00:00+00:00'
                                  duration: 90
                                  startDate: '2025-01-01T00:00:00+00:00'
                                  expireDate: '2025-01-01T00:00:00+00:00'
                                  cancelDate: null
                                  price: 0
                                  regularPrice: 5
                                  discount: 0
                                  earningId: 0
                                  action: subscribe
                                  type: trial
                                  offerStart: '2025-01-01T00:00:00+00:00'
                                  offerEnd: null
                                  isCurrent: true
                              hasActivePaidSubscriptions: false
                            canTrialSend: false
                            isBlocked: false
                            promoOffers:
                              -
                                id: 123
                                subscribeDays: 90
                                createdAt: '2025-01-01T00:00:00+00:00'
                                expiredAt: null
                                finishedAt: '2025-01-01T00:00:00+00:00'
                                subscriberId: '123'
                                userId: '123'
                            canUnsubscribe: true
                            isPendingAutoprolong: false
                        items:
                          type: object
                          properties:
                            view:
                              type: string
                              example: x
                            avatar:
                              type: string
                              example: 'https://public.onlyfans.com/files/.../avatar.jpg'
                            avatarThumbs:
                              type: object
                              properties:
                                c50:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg'
                                c144:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg'
                            header:
                              type: string
                              example: 'https://public.onlyfans.com/files/.../header.jpg'
                            headerSize:
                              type: object
                              properties:
                                width:
                                  type: integer
                                  example: 2160
                                height:
                                  type: integer
                                  example: 2700
                            headerThumbs:
                              type: object
                              properties:
                                w480:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg'
                                w760:
                                  type: string
                                  example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg'
                            id:
                              type: integer
                              example: 123
                            name:
                              type: string
                              example: name
                            username:
                              type: string
                              example: username
                            canLookStory:
                              type: boolean
                              example: true
                            canCommentStory:
                              type: boolean
                              example: true
                            hasNotViewedStory:
                              type: boolean
                              example: false
                            isVerified:
                              type: boolean
                              example: false
                            canPayInternal:
                              type: boolean
                              example: true
                            hasScheduledStream:
                              type: boolean
                              example: false
                            hasStream:
                              type: boolean
                              example: false
                            hasStories:
                              type: boolean
                              example: false
                            tipsEnabled:
                              type: boolean
                              example: false
                            tipsTextEnabled:
                              type: boolean
                              example: true
                            tipsMin:
                              type: integer
                              example: 5
                            tipsMinInternal:
                              type: integer
                              example: 1
                            tipsMax:
                              type: integer
                              example: 200
                            canEarn:
                              type: boolean
                              example: false
                            canAddSubscriber:
                              type: boolean
                              example: false
                            subscribePrice:
                              type: integer
                              example: 0
                            displayName:
                              type: string
                              example: ''
                            notice:
                              type: string
                              example: ''
                            isRestricted:
                              type: boolean
                              example: false
                            canRestrict:
                              type: boolean
                              example: true
                            subscribedBy:
                              type: boolean
                              example: true
                            subscribedByExpire:
                              type: boolean
                              example: false
                            subscribedByExpireDate:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            subscribedByAutoprolong:
                              type: boolean
                              example: true
                            subscribedIsExpiredNow:
                              type: boolean
                              example: false
                            currentSubscribePrice:
                              type: integer
                              example: 0
                            subscribedOn:
                              type: boolean
                              example: true
                            subscribedOnExpiredNow:
                              type: boolean
                              example: false
                            subscribedOnDuration:
                              type: string
                              example: '3 days'
                            listsStates:
                              type: array
                              example:
                                -
                                  id: fans
                                  type: fans
                                  name: Fans
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: following
                                  type: following
                                  name: Following
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: friends
                                  type: friends
                                  name: Friends
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: USER_NOT_PERFORMER
                                -
                                  id: muted
                                  type: muted
                                  name: Muted
                                  hasUser: false
                                  canAddUser: true
                                  cannotAddUserReason: null
                                -
                                  id: recent
                                  type: recent
                                  name: 'Recent (last 24 hours)'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                                -
                                  id: rebill_off
                                  type: rebill_off
                                  name: 'Renew Off'
                                  hasUser: true
                                  canAddUser: false
                                  cannotAddUserReason: ALREADY_EXISTS
                                -
                                  id: rebill_on
                                  type: rebill_on
                                  name: 'Renew On'
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: null
                                -
                                  id: tagged
                                  type: tagged
                                  name: Tagged
                                  hasUser: false
                                  canAddUser: false
                                  cannotAddUserReason: SYSTEM_LIST
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: fans
                                  type:
                                    type: string
                                    example: fans
                                  name:
                                    type: string
                                    example: Fans
                                  hasUser:
                                    type: boolean
                                    example: true
                                  canAddUser:
                                    type: boolean
                                    example: false
                                  cannotAddUserReason:
                                    type: string
                                    example: ALREADY_EXISTS
                            canReport:
                              type: boolean
                              example: true
                            canReceiveChatMessage:
                              type: boolean
                              example: true
                            hideChat:
                              type: boolean
                              example: false
                            lastSeen:
                              type: string
                              example: '2025-01-01T00:00:00+00:00'
                            isPerformer:
                              type: boolean
                              example: false
                            isRealPerformer:
                              type: boolean
                              example: false
                            subscribedByData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                subscribePrice:
                                  type: integer
                                  example: 0
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: null
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '3 days'
                                showPostsInFeed:
                                  type: boolean
                                  example: true
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 123
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 0
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: auto
                                      offerStart: null
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 123 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 0 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: auto }
                                      offerStart: { type: string, example: null }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            subscribedOnData:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  example: 0
                                newPrice:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 5
                                subscribePrice:
                                  type: integer
                                  example: 5
                                discountPercent:
                                  type: integer
                                  example: 0
                                discountPeriod:
                                  type: integer
                                  example: 1
                                subscribeAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                expiredAt:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                renewedAt:
                                  type: string
                                  example: null
                                discountFinishedAt:
                                  type: string
                                  example: null
                                discountStartedAt:
                                  type: string
                                  example: null
                                status:
                                  type: string
                                  example: 'Set to Expire'
                                isMuted:
                                  type: boolean
                                  example: false
                                unsubscribeReason:
                                  type: string
                                  example: 'No reason given'
                                duration:
                                  type: string
                                  example: '3 days'
                                tipsSumm:
                                  type: integer
                                  example: 0
                                subscribesSumm:
                                  type: integer
                                  example: 0
                                messagesSumm:
                                  type: integer
                                  example: 0
                                postsSumm:
                                  type: integer
                                  example: 0
                                streamsSumm:
                                  type: integer
                                  example: 0
                                totalSumm:
                                  type: integer
                                  example: 0
                                lastActivity:
                                  type: string
                                  example: '2025-01-01T00:00:00+00:00'
                                recommendations:
                                  type: integer
                                  example: 0
                                subscribes:
                                  type: array
                                  example:
                                    -
                                      id: 123
                                      userId: 123
                                      subscriberId: 123
                                      date: '2025-01-01T00:00:00+00:00'
                                      duration: 90
                                      startDate: '2025-01-01T00:00:00+00:00'
                                      expireDate: '2025-01-01T00:00:00+00:00'
                                      cancelDate: null
                                      price: 0
                                      regularPrice: 5
                                      discount: 0
                                      earningId: 0
                                      action: subscribe
                                      type: trial
                                      offerStart: '2025-01-01T00:00:00+00:00'
                                      offerEnd: null
                                      isCurrent: true
                                  items:
                                    type: object
                                    properties:
                                      id: { type: integer, example: 123 }
                                      userId: { type: integer, example: 123 }
                                      subscriberId: { type: integer, example: 123 }
                                      date: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      duration: { type: integer, example: 90 }
                                      startDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      expireDate: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      cancelDate: { type: string, example: null }
                                      price: { type: integer, example: 0 }
                                      regularPrice: { type: integer, example: 5 }
                                      discount: { type: integer, example: 0 }
                                      earningId: { type: integer, example: 0 }
                                      action: { type: string, example: subscribe }
                                      type: { type: string, example: trial }
                                      offerStart: { type: string, example: '2025-01-01T00:00:00+00:00' }
                                      offerEnd: { type: string, example: null }
                                      isCurrent: { type: boolean, example: true }
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  example: false
                            canTrialSend:
                              type: boolean
                              example: false
                            isBlocked:
                              type: boolean
                              example: false
                            promoOffers:
                              type: array
                              example:
                                -
                                  id: 123
                                  subscribeDays: 90
                                  createdAt: '2025-01-01T00:00:00+00:00'
                                  expiredAt: null
                                  finishedAt: '2025-01-01T00:00:00+00:00'
                                  subscriberId: '123'
                                  userId: '123'
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 123
                                  subscribeDays:
                                    type: integer
                                    example: 90
                                  createdAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  expiredAt:
                                    type: string
                                    example: null
                                  finishedAt:
                                    type: string
                                    example: '2025-01-01T00:00:00+00:00'
                                  subscriberId:
                                    type: string
                                    example: '123'
                                  userId:
                                    type: string
                                    example: '123'
                            canUnsubscribe:
                              type: boolean
                              example: true
                            isPendingAutoprolong:
                              type: boolean
                              example: false
                      nextOffset:
                        type: integer
                        example: 3
                      hasMore:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999977
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 997
                          remaining_day:
                            type: integer
                            example: 49989
      tags:
        - 'User List Collections'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: userListId
        description: 'OnlyFans User List ID, or a default list name like `friends`'
        example: friends
        required: true
        schema:
          type: string
  '/api/{account}/user-lists/{userListId}/users/{userId}':
    delete:
      summary: 'Remove User from a User List'
      operationId: removeUserFromAUserList
      description: 'Remove User from OnlyFans User List'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    list:
                      id: 1224114714
                      type: custom
                      name: 'Custom - OFAPI Test'
                      usersCount: 2
                      postsCount: 257
                      order: default
                      direction: asc
                      canUpdate: true
                      canDelete: true
                      canManageUsers: true
                      canAddUsers: true
                      canPinnedToFeed: true
                      isPinnedToFeed: false
                      canPinnedToChat: true
                      isPinnedToChat: false
                      sortList: []
                      users:
                        -
                          view: t
                          id: 254
                          name: 'OnlyFans Creators'
                          username: onlyfanscreators
                          isVerified: true
                          avatar: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                          avatarThumbs:
                            c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                    userState:
                      id: 1224114714
                      type: custom
                      name: 'Custom - OFAPI Test'
                      hasUser: false
                      canAddUser: true
                      cannotAddUserReason: null
                  _meta:
                    _credits:
                      used: 1
                      balance: 224743
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49945
                properties:
                  data:
                    type: object
                    properties:
                      list:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1224114714
                          type:
                            type: string
                            example: custom
                          name:
                            type: string
                            example: 'Custom - OFAPI Test'
                          usersCount:
                            type: integer
                            example: 2
                          postsCount:
                            type: integer
                            example: 257
                          order:
                            type: string
                            example: default
                          direction:
                            type: string
                            example: asc
                          canUpdate:
                            type: boolean
                            example: true
                          canDelete:
                            type: boolean
                            example: true
                          canManageUsers:
                            type: boolean
                            example: true
                          canAddUsers:
                            type: boolean
                            example: true
                          canPinnedToFeed:
                            type: boolean
                            example: true
                          isPinnedToFeed:
                            type: boolean
                            example: false
                          canPinnedToChat:
                            type: boolean
                            example: true
                          isPinnedToChat:
                            type: boolean
                            example: false
                          sortList:
                            type: array
                            example: []
                          users:
                            type: array
                            example:
                              -
                                view: t
                                id: 254
                                name: 'OnlyFans Creators'
                                username: onlyfanscreators
                                isVerified: true
                                avatar: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                                avatarThumbs:
                                  c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                                  c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                            items:
                              type: object
                              properties:
                                view:
                                  type: string
                                  example: t
                                id:
                                  type: integer
                                  example: 254
                                name:
                                  type: string
                                  example: 'OnlyFans Creators'
                                username:
                                  type: string
                                  example: onlyfanscreators
                                isVerified:
                                  type: boolean
                                  example: true
                                avatar:
                                  type: string
                                  example: 'https://public.onlyfans.com/files/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                                avatarThumbs:
                                  type: object
                                  properties:
                                    c50:
                                      type: string
                                      example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                                    c144:
                                      type: string
                                      example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/j/jr/jrh/jrhrmrkcgwyldumcgfgsij7h9hncsf3b1640855614/avatar.jpg'
                      userState:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1224114714
                          type:
                            type: string
                            example: custom
                          name:
                            type: string
                            example: 'Custom - OFAPI Test'
                          hasUser:
                            type: boolean
                            example: false
                          canAddUser:
                            type: boolean
                            example: true
                          cannotAddUserReason:
                            type: string
                            example: null
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 224743
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49945
      tags:
        - 'User List Collections'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: userListId
        description: 'OnlyFans User List ID'
        example: 1224114714
        required: true
        schema:
          type: string
      -
        in: path
        name: userId
        description: 'OnlyFans User ID'
        example: 123456
        required: true
        schema:
          type: integer
  '/api/{account}/user-lists/{userListId}/users/{userId}/pin':
    post:
      summary: 'Pin/Unpin User in User List'
      operationId: pinUnpinUserInUserList
      description: 'Pin a user in any OnlyFans user list.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999883
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: null
                      remaining_minute: 998
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999883
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - 'User List Collections'
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: userListId
        description: 'OnlyFans User List ID, or a default list name like `friends`'
        example: friends
        required: true
        schema:
          type: string
      -
        in: path
        name: userId
        description: 'OnlyFans User ID to pin or unpin'
        example: 1145988
        required: true
        schema:
          type: integer
  '/api/{account}/users/list':
    get:
      summary: 'Mass-List User Details'
      operationId: massListUserDetails
      description: 'Save on credits by getting up to 10 user details with a single request. User details are retrieved using the current `{account}` so fields like `subscribedOnData` which include potential subscription details will be included.'
      parameters:
        -
          in: query
          name: ids
          description: 'Comma-separated list of user IDs (max. 10 IDs). Must be at least 1 character.'
          example: '12412412,36139491,1858349'
          required: true
          schema:
            type: string
            description: 'Comma-separated list of user IDs (max. 10 IDs). Must be at least 1 character.'
            example: '12412412,36139491,1858349'
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    '1000000':
                      view: f
                      avatar: 'https://example.com/redacted.jpg'
                      avatarThumbs:
                        c50: 'https://example.com/redacted.jpg'
                        c144: 'https://example.com/redacted.jpg'
                      header: null
                      headerSize: null
                      headerThumbs: null
                      id: 1000000
                      name: 'Example User'
                      username: example_user
                      canLookStory: true
                      canCommentStory: true
                      hasNotViewedStory: false
                      isVerified: true
                      canPayInternal: true
                      hasScheduledStream: false
                      hasStream: false
                      hasStories: false
                      tipsEnabled: false
                      tipsTextEnabled: true
                      tipsMin: 5
                      tipsMinInternal: 1
                      tipsMax: 200
                      canEarn: true
                      canAddSubscriber: false
                      subscribePrice: 0
                      displayName: 'Example User'
                      notice: ''
                      isPaywallRequired: true
                      isActive: true
                      isRestricted: false
                      canRestrict: true
                      subscribedBy: true
                      subscribedByExpire: false
                      subscribedByExpireDate: '2024-01-01T00:00:00+00:00'
                      subscribedByAutoprolong: false
                      subscribedIsExpiredNow: false
                      currentSubscribePrice: 0
                      subscribedOn: null
                      subscribedOnExpiredNow: true
                      subscribedOnDuration: '1 month'
                      listsStates:
                        -
                          id: redacted_id
                          type: muted
                          name: 'Example User'
                          hasUser: false
                          canAddUser: true
                          cannotAddUserReason: null
                        -
                          id: redacted_id
                          type: fans
                          name: 'Example User'
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: null
                        -
                          id: redacted_id
                          type: following
                          name: 'Example User'
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        -
                          id: redacted_id
                          type: recent
                          name: 'Example User'
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: SYSTEM_LIST
                        -
                          id: redacted_id
                          type: friends
                          name: 'Example User'
                          hasUser: false
                          canAddUser: true
                          cannotAddUserReason: null
                        -
                          id: 1000000
                          type: custom
                          name: 'Example User'
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        -
                          id: 1000000
                          type: custom
                          name: 'Example User'
                          hasUser: true
                          canAddUser: false
                          cannotAddUserReason: ALREADY_EXISTS
                        -
                          id: redacted_id
                          type: rebill_off
                          name: 'Example User'
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: null
                        -
                          id: redacted_id
                          type: rebill_on
                          name: 'Example User'
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: null
                        -
                          id: redacted_id
                          type: tagged
                          name: 'Example User'
                          hasUser: false
                          canAddUser: false
                          cannotAddUserReason: SYSTEM_LIST
                      joinDate: '2024-01-01T00:00:00+00:00'
                      isReferrerAllowed: true
                      about: ''
                      isMarkdownDisabledForAbout: false
                      website: null
                      wishlist: null
                      location: null
                      postsCount: 0
                      archivedPostsCount: 0
                      privateArchivedPostsCount: 0
                      photosCount: 0
                      videosCount: 0
                      audiosCount: 0
                      mediasCount: 0
                      lastSeen: '2024-01-01T00:00:00+00:00'
                      favoritesCount: 0
                      favoritedCount: 0
                      showPostsInFeed: true
                      canReceiveChatMessage: true
                      isPerformer: true
                      isRealPerformer: true
                      isSpotifyConnected: false
                      subscribersCount: null
                      hasPinnedPosts: false
                      hasLabels: false
                      canChat: true
                      avatarHeaderConverterUpload: true
                      isPrivateRestriction: false
                      showSubscribersCount: false
                      showMediaCount: true
                      subscribedByData:
                        price: 0
                        newPrice: 0
                        regularPrice: 0
                        subscribePrice: 0
                        discountPercent: 0
                        discountPeriod: 1
                        subscribeAt: '2024-01-01T00:00:00+00:00'
                        expiredAt: '2024-01-01T00:00:00+00:00'
                        renewedAt: null
                        discountFinishedAt: null
                        discountStartedAt: null
                        status: 'Set to Expire'
                        isMuted: false
                        unsubscribeReason: Redacted
                        duration: '6 months'
                        showPostsInFeed: true
                        subscribes:
                          -
                            id: 1000000
                            userId: 1000000
                            subscriberId: 1000000
                            date: '2024-01-01T00:00:00+00:00'
                            duration: 3652
                            startDate: '2024-01-01T00:00:00+00:00'
                            expireDate: '2024-01-01T00:00:00+00:00'
                            cancelDate: null
                            price: 0
                            regularPrice: 0
                            discount: 0
                            earningId: 0
                            action: subscribe
                            type: regular
                            offerStart: null
                            offerEnd: null
                            isCurrent: true
                          -
                            id: 1000000
                            userId: 1000000
                            subscriberId: 1000000
                            date: '2024-01-01T00:00:00+00:00'
                            duration: 3652
                            startDate: '2024-01-01T00:00:00+00:00'
                            expireDate: '2024-01-01T00:00:00+00:00'
                            cancelDate: null
                            price: 0
                            regularPrice: 0
                            discount: 0
                            earningId: 0
                            action: prolong
                            type: regular
                            offerStart: null
                            offerEnd: null
                            isCurrent: true
                        hasActivePaidSubscriptions: false
                      subscribedOnData:
                        price: 3.9
                        newPrice: 12.99
                        regularPrice: 12.99
                        subscribePrice: 12.99
                        discountPercent: 0
                        discountPeriod: 1
                        subscribeAt: '2024-01-01T00:00:00+00:00'
                        expiredAt: '2024-01-01T00:00:00+00:00'
                        renewedAt: null
                        discountFinishedAt: null
                        discountStartedAt: null
                        status: null
                        isMuted: false
                        unsubscribeReason: Redacted
                        duration: '8 months'
                        tipsSumm: 0
                        subscribesSumm: 0
                        messagesSumm: 0
                        postsSumm: 0
                        streamsSumm: 0
                        totalSumm: 0
                        subscribes: []
                        hasActivePaidSubscriptions: false
                      canCreatePromotion: false
                      canCreateTrial: false
                      isAdultContent: false
                      canTrialSend: true
                      hasLinks: false
                      hasFriends: true
                      firstPublishedPostDate: '2024-01-01T00:00:00+00:00'
                      isSpringConnected: false
                      isFriend: false
                      isBlocked: false
                      canReport: true
                      canUnsubscribe: true
                      isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 380044
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 5000
                      limit_day: null
                      remaining_minute: 4999
                      remaining_day: null
                      notice: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
                properties:
                  data:
                    type: object
                    properties:
                      1000000:
                        type: object
                        properties:
                          view:
                            type: string
                            example: f
                          avatar:
                            type: string
                            example: 'https://example.com/redacted.jpg'
                          avatarThumbs:
                            type: object
                            properties:
                              c50:
                                type: string
                                example: 'https://example.com/redacted.jpg'
                              c144:
                                type: string
                                example: 'https://example.com/redacted.jpg'
                          header:
                            type: string
                            example: null
                          headerSize:
                            type: string
                            example: null
                          headerThumbs:
                            type: string
                            example: null
                          id:
                            type: integer
                            example: 1000000
                          name:
                            type: string
                            example: 'Example User'
                          username:
                            type: string
                            example: example_user
                          canLookStory:
                            type: boolean
                            example: true
                          canCommentStory:
                            type: boolean
                            example: true
                          hasNotViewedStory:
                            type: boolean
                            example: false
                          isVerified:
                            type: boolean
                            example: true
                          canPayInternal:
                            type: boolean
                            example: true
                          hasScheduledStream:
                            type: boolean
                            example: false
                          hasStream:
                            type: boolean
                            example: false
                          hasStories:
                            type: boolean
                            example: false
                          tipsEnabled:
                            type: boolean
                            example: false
                          tipsTextEnabled:
                            type: boolean
                            example: true
                          tipsMin:
                            type: integer
                            example: 5
                          tipsMinInternal:
                            type: integer
                            example: 1
                          tipsMax:
                            type: integer
                            example: 200
                          canEarn:
                            type: boolean
                            example: true
                          canAddSubscriber:
                            type: boolean
                            example: false
                          subscribePrice:
                            type: integer
                            example: 0
                          displayName:
                            type: string
                            example: 'Example User'
                          notice:
                            type: string
                            example: ''
                          isPaywallRequired:
                            type: boolean
                            example: true
                          isActive:
                            type: boolean
                            example: true
                          isRestricted:
                            type: boolean
                            example: false
                          canRestrict:
                            type: boolean
                            example: true
                          subscribedBy:
                            type: boolean
                            example: true
                          subscribedByExpire:
                            type: boolean
                            example: false
                          subscribedByExpireDate:
                            type: string
                            example: '2024-01-01T00:00:00+00:00'
                          subscribedByAutoprolong:
                            type: boolean
                            example: false
                          subscribedIsExpiredNow:
                            type: boolean
                            example: false
                          currentSubscribePrice:
                            type: integer
                            example: 0
                          subscribedOn:
                            type: string
                            example: null
                          subscribedOnExpiredNow:
                            type: boolean
                            example: true
                          subscribedOnDuration:
                            type: string
                            example: '1 month'
                          listsStates:
                            type: array
                            example:
                              -
                                id: redacted_id
                                type: muted
                                name: 'Example User'
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: redacted_id
                                type: fans
                                name: 'Example User'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              -
                                id: redacted_id
                                type: following
                                name: 'Example User'
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: redacted_id
                                type: recent
                                name: 'Example User'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                              -
                                id: redacted_id
                                type: friends
                                name: 'Example User'
                                hasUser: false
                                canAddUser: true
                                cannotAddUserReason: null
                              -
                                id: 1000000
                                type: custom
                                name: 'Example User'
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: 1000000
                                type: custom
                                name: 'Example User'
                                hasUser: true
                                canAddUser: false
                                cannotAddUserReason: ALREADY_EXISTS
                              -
                                id: redacted_id
                                type: rebill_off
                                name: 'Example User'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              -
                                id: redacted_id
                                type: rebill_on
                                name: 'Example User'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: null
                              -
                                id: redacted_id
                                type: tagged
                                name: 'Example User'
                                hasUser: false
                                canAddUser: false
                                cannotAddUserReason: SYSTEM_LIST
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: redacted_id
                                type:
                                  type: string
                                  example: muted
                                name:
                                  type: string
                                  example: 'Example User'
                                hasUser:
                                  type: boolean
                                  example: false
                                canAddUser:
                                  type: boolean
                                  example: true
                                cannotAddUserReason:
                                  type: string
                                  example: null
                          joinDate:
                            type: string
                            example: '2024-01-01T00:00:00+00:00'
                          isReferrerAllowed:
                            type: boolean
                            example: true
                          about:
                            type: string
                            example: ''
                          isMarkdownDisabledForAbout:
                            type: boolean
                            example: false
                          website:
                            type: string
                            example: null
                          wishlist:
                            type: string
                            example: null
                          location:
                            type: string
                            example: null
                          postsCount:
                            type: integer
                            example: 0
                          archivedPostsCount:
                            type: integer
                            example: 0
                          privateArchivedPostsCount:
                            type: integer
                            example: 0
                          photosCount:
                            type: integer
                            example: 0
                          videosCount:
                            type: integer
                            example: 0
                          audiosCount:
                            type: integer
                            example: 0
                          mediasCount:
                            type: integer
                            example: 0
                          lastSeen:
                            type: string
                            example: '2024-01-01T00:00:00+00:00'
                          favoritesCount:
                            type: integer
                            example: 0
                          favoritedCount:
                            type: integer
                            example: 0
                          showPostsInFeed:
                            type: boolean
                            example: true
                          canReceiveChatMessage:
                            type: boolean
                            example: true
                          isPerformer:
                            type: boolean
                            example: true
                          isRealPerformer:
                            type: boolean
                            example: true
                          isSpotifyConnected:
                            type: boolean
                            example: false
                          subscribersCount:
                            type: string
                            example: null
                          hasPinnedPosts:
                            type: boolean
                            example: false
                          hasLabels:
                            type: boolean
                            example: false
                          canChat:
                            type: boolean
                            example: true
                          avatarHeaderConverterUpload:
                            type: boolean
                            example: true
                          isPrivateRestriction:
                            type: boolean
                            example: false
                          showSubscribersCount:
                            type: boolean
                            example: false
                          showMediaCount:
                            type: boolean
                            example: true
                          subscribedByData:
                            type: object
                            properties:
                              price:
                                type: integer
                                example: 0
                              newPrice:
                                type: integer
                                example: 0
                              regularPrice:
                                type: integer
                                example: 0
                              subscribePrice:
                                type: integer
                                example: 0
                              discountPercent:
                                type: integer
                                example: 0
                              discountPeriod:
                                type: integer
                                example: 1
                              subscribeAt:
                                type: string
                                example: '2024-01-01T00:00:00+00:00'
                              expiredAt:
                                type: string
                                example: '2024-01-01T00:00:00+00:00'
                              renewedAt:
                                type: string
                                example: null
                              discountFinishedAt:
                                type: string
                                example: null
                              discountStartedAt:
                                type: string
                                example: null
                              status:
                                type: string
                                example: 'Set to Expire'
                              isMuted:
                                type: boolean
                                example: false
                              unsubscribeReason:
                                type: string
                                example: Redacted
                              duration:
                                type: string
                                example: '6 months'
                              showPostsInFeed:
                                type: boolean
                                example: true
                              subscribes:
                                type: array
                                example:
                                  -
                                    id: 1000000
                                    userId: 1000000
                                    subscriberId: 1000000
                                    date: '2024-01-01T00:00:00+00:00'
                                    duration: 3652
                                    startDate: '2024-01-01T00:00:00+00:00'
                                    expireDate: '2024-01-01T00:00:00+00:00'
                                    cancelDate: null
                                    price: 0
                                    regularPrice: 0
                                    discount: 0
                                    earningId: 0
                                    action: subscribe
                                    type: regular
                                    offerStart: null
                                    offerEnd: null
                                    isCurrent: true
                                  -
                                    id: 1000000
                                    userId: 1000000
                                    subscriberId: 1000000
                                    date: '2024-01-01T00:00:00+00:00'
                                    duration: 3652
                                    startDate: '2024-01-01T00:00:00+00:00'
                                    expireDate: '2024-01-01T00:00:00+00:00'
                                    cancelDate: null
                                    price: 0
                                    regularPrice: 0
                                    discount: 0
                                    earningId: 0
                                    action: prolong
                                    type: regular
                                    offerStart: null
                                    offerEnd: null
                                    isCurrent: true
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1000000
                                    userId:
                                      type: integer
                                      example: 1000000
                                    subscriberId:
                                      type: integer
                                      example: 1000000
                                    date:
                                      type: string
                                      example: '2024-01-01T00:00:00+00:00'
                                    duration:
                                      type: integer
                                      example: 3652
                                    startDate:
                                      type: string
                                      example: '2024-01-01T00:00:00+00:00'
                                    expireDate:
                                      type: string
                                      example: '2024-01-01T00:00:00+00:00'
                                    cancelDate:
                                      type: string
                                      example: null
                                    price:
                                      type: integer
                                      example: 0
                                    regularPrice:
                                      type: integer
                                      example: 0
                                    discount:
                                      type: integer
                                      example: 0
                                    earningId:
                                      type: integer
                                      example: 0
                                    action:
                                      type: string
                                      example: subscribe
                                    type:
                                      type: string
                                      example: regular
                                    offerStart:
                                      type: string
                                      example: null
                                    offerEnd:
                                      type: string
                                      example: null
                                    isCurrent:
                                      type: boolean
                                      example: true
                              hasActivePaidSubscriptions:
                                type: boolean
                                example: false
                          subscribedOnData:
                            type: object
                            properties:
                              price:
                                type: number
                                example: 3.9
                              newPrice:
                                type: number
                                example: 12.99
                              regularPrice:
                                type: number
                                example: 12.99
                              subscribePrice:
                                type: number
                                example: 12.99
                              discountPercent:
                                type: integer
                                example: 0
                              discountPeriod:
                                type: integer
                                example: 1
                              subscribeAt:
                                type: string
                                example: '2024-01-01T00:00:00+00:00'
                              expiredAt:
                                type: string
                                example: '2024-01-01T00:00:00+00:00'
                              renewedAt:
                                type: string
                                example: null
                              discountFinishedAt:
                                type: string
                                example: null
                              discountStartedAt:
                                type: string
                                example: null
                              status:
                                type: string
                                example: null
                              isMuted:
                                type: boolean
                                example: false
                              unsubscribeReason:
                                type: string
                                example: Redacted
                              duration:
                                type: string
                                example: '8 months'
                              tipsSumm:
                                type: integer
                                example: 0
                              subscribesSumm:
                                type: integer
                                example: 0
                              messagesSumm:
                                type: integer
                                example: 0
                              postsSumm:
                                type: integer
                                example: 0
                              streamsSumm:
                                type: integer
                                example: 0
                              totalSumm:
                                type: integer
                                example: 0
                              subscribes:
                                type: array
                                example: []
                              hasActivePaidSubscriptions:
                                type: boolean
                                example: false
                          canCreatePromotion:
                            type: boolean
                            example: false
                          canCreateTrial:
                            type: boolean
                            example: false
                          isAdultContent:
                            type: boolean
                            example: false
                          canTrialSend:
                            type: boolean
                            example: true
                          hasLinks:
                            type: boolean
                            example: false
                          hasFriends:
                            type: boolean
                            example: true
                          firstPublishedPostDate:
                            type: string
                            example: '2024-01-01T00:00:00+00:00'
                          isSpringConnected:
                            type: boolean
                            example: false
                          isFriend:
                            type: boolean
                            example: false
                          isBlocked:
                            type: boolean
                            example: false
                          canReport:
                            type: boolean
                            example: true
                          canUnsubscribe:
                            type: boolean
                            example: true
                          isPendingAutoprolong:
                            type: boolean
                            example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 380044
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 5000
                          limit_day:
                            type: string
                            example: null
                          remaining_minute:
                            type: integer
                            example: 4999
                          remaining_day:
                            type: string
                            example: null
                          notice:
                            type: string
                            example: 'We have decided to remove our daily rate limits. Please remove any references to these in your integrations.'
      tags:
        - Users
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
  '/api/{account}/users/{username}':
    get:
      summary: 'Get User Details'
      operationId: getUserDetails
      description: 'Get OnlyFans Profile details for a given username. User details are retrieved using the current `{account}` so fields like `subscribedOnData` which include potential subscription details will be included.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                    header: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: true
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: true
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      -
                        id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ''
                    notice: ''
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: '7 days'
                    listsStates:
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    joinDate: '2025-01-01T01:01:01+00:00'
                    isReferrerAllowed: true
                    about: About
                    isMarkdownDisabledForAbout: true
                    website: null
                    wishlist: null
                    location: location
                    postsCount: 123
                    archivedPostsCount: 1
                    privateArchivedPostsCount: 123
                    photosCount: 123
                    videosCount: 63
                    audiosCount: 0
                    mediasCount: 123
                    lastSeen: '2025-01-01T01:01:01+00:00'
                    favoritesCount: 123
                    favoritedCount: 123
                    showPostsInFeed: true
                    canReceiveChatMessage: true
                    isPerformer: true
                    isRealPerformer: true
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: 'Set to Expire'
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '2 months'
                      showPostsInFeed: true
                      subscribes:
                        -
                          id: 123
                          userId: 123
                          subscriberId: 123
                          date: '2025-01-01T01:01:01+00:00'
                          duration: 360
                          startDate: '2025-01-01T01:01:01+00:00'
                          expireDate: '2025-01-01T01:01:01+00:00'
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: '2025-01-01T01:01:01+00:00'
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '7 days'
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canCreatePromotion: true
                    canCreateTrial: true
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    finishedStreamsCount: 0
                    shouldShowFinishedStreams: false
                    hasSavedStreams: false
                    firstPublishedPostDate: '2025-01-01T01:01:01+00:00'
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: true
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999834
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: true
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: true
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          -
                            id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ''
                      notice:
                        type: string
                        example: ''
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: '7 days'
                      listsStates:
                        type: array
                        example:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      joinDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: About
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: null
                      wishlist:
                        type: string
                        example: null
                      location:
                        type: string
                        example: location
                      postsCount:
                        type: integer
                        example: 123
                      archivedPostsCount:
                        type: integer
                        example: 1
                      privateArchivedPostsCount:
                        type: integer
                        example: 123
                      photosCount:
                        type: integer
                        example: 123
                      videosCount:
                        type: integer
                        example: 63
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 123
                      lastSeen:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      favoritesCount:
                        type: integer
                        example: 123
                      favoritedCount:
                        type: integer
                        example: 123
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: 'Set to Expire'
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '2 months'
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              -
                                id: 123
                                userId: 123
                                subscriberId: 123
                                date: '2025-01-01T01:01:01+00:00'
                                duration: 360
                                startDate: '2025-01-01T01:01:01+00:00'
                                expireDate: '2025-01-01T01:01:01+00:00'
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: '2025-01-01T01:01:01+00:00'
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                duration:
                                  type: integer
                                  example: 360
                                startDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                expireDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                cancelDate:
                                  type: string
                                  example: null
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                offerEnd:
                                  type: string
                                  example: null
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '7 days'
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canCreatePromotion:
                        type: boolean
                        example: true
                      canCreateTrial:
                        type: boolean
                        example: true
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      finishedStreamsCount:
                        type: integer
                        example: 0
                      shouldShowFinishedStreams:
                        type: boolean
                        example: false
                      hasSavedStreams:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: true
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999834
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Users
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: username
        description: 'The OnlyFans username of the user to retrieve details for.'
        example: exampleuser
        required: true
        schema:
          type: string
  '/api/{account}/users/{user_id}/restrict':
    post:
      summary: 'Restrict User'
      operationId: restrictUser
      description: 'Restrict a user. You will not see messages or comments from this them.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                    header: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: true
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: true
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      -
                        id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ''
                    notice: ''
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: '7 days'
                    listsStates:
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    joinDate: '2025-01-01T01:01:01+00:00'
                    isReferrerAllowed: true
                    about: About
                    isMarkdownDisabledForAbout: true
                    website: null
                    wishlist: null
                    location: location
                    postsCount: 123
                    archivedPostsCount: 1
                    privateArchivedPostsCount: 123
                    photosCount: 123
                    videosCount: 63
                    audiosCount: 0
                    mediasCount: 123
                    lastSeen: '2025-01-01T01:01:01+00:00'
                    favoritesCount: 123
                    favoritedCount: 123
                    showPostsInFeed: true
                    canReceiveChatMessage: true
                    isPerformer: true
                    isRealPerformer: true
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: 'Set to Expire'
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '2 months'
                      showPostsInFeed: true
                      subscribes:
                        -
                          id: 123
                          userId: 123
                          subscriberId: 123
                          date: '2025-01-01T01:01:01+00:00'
                          duration: 360
                          startDate: '2025-01-01T01:01:01+00:00'
                          expireDate: '2025-01-01T01:01:01+00:00'
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: '2025-01-01T01:01:01+00:00'
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '7 days'
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canCreatePromotion: true
                    canCreateTrial: true
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    finishedStreamsCount: 0
                    shouldShowFinishedStreams: false
                    hasSavedStreams: false
                    firstPublishedPostDate: '2025-01-01T01:01:01+00:00'
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: true
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999834
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: true
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: true
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          -
                            id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ''
                      notice:
                        type: string
                        example: ''
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: '7 days'
                      listsStates:
                        type: array
                        example:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      joinDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: About
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: null
                      wishlist:
                        type: string
                        example: null
                      location:
                        type: string
                        example: location
                      postsCount:
                        type: integer
                        example: 123
                      archivedPostsCount:
                        type: integer
                        example: 1
                      privateArchivedPostsCount:
                        type: integer
                        example: 123
                      photosCount:
                        type: integer
                        example: 123
                      videosCount:
                        type: integer
                        example: 63
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 123
                      lastSeen:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      favoritesCount:
                        type: integer
                        example: 123
                      favoritedCount:
                        type: integer
                        example: 123
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: 'Set to Expire'
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '2 months'
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              -
                                id: 123
                                userId: 123
                                subscriberId: 123
                                date: '2025-01-01T01:01:01+00:00'
                                duration: 360
                                startDate: '2025-01-01T01:01:01+00:00'
                                expireDate: '2025-01-01T01:01:01+00:00'
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: '2025-01-01T01:01:01+00:00'
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                duration:
                                  type: integer
                                  example: 360
                                startDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                expireDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                cancelDate:
                                  type: string
                                  example: null
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                offerEnd:
                                  type: string
                                  example: null
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '7 days'
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canCreatePromotion:
                        type: boolean
                        example: true
                      canCreateTrial:
                        type: boolean
                        example: true
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      finishedStreamsCount:
                        type: integer
                        example: 0
                      shouldShowFinishedStreams:
                        type: boolean
                        example: false
                      hasSavedStreams:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: true
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999834
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Users
    delete:
      summary: 'Unrestrict User'
      operationId: unrestrictUser
      description: 'Unrestrict a previously restricted user. You will start seeing messages and comments from them again.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                    header: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: true
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: true
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      -
                        id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ''
                    notice: ''
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: '7 days'
                    listsStates:
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    joinDate: '2025-01-01T01:01:01+00:00'
                    isReferrerAllowed: true
                    about: About
                    isMarkdownDisabledForAbout: true
                    website: null
                    wishlist: null
                    location: location
                    postsCount: 123
                    archivedPostsCount: 1
                    privateArchivedPostsCount: 123
                    photosCount: 123
                    videosCount: 63
                    audiosCount: 0
                    mediasCount: 123
                    lastSeen: '2025-01-01T01:01:01+00:00'
                    favoritesCount: 123
                    favoritedCount: 123
                    showPostsInFeed: true
                    canReceiveChatMessage: true
                    isPerformer: true
                    isRealPerformer: true
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: 'Set to Expire'
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '2 months'
                      showPostsInFeed: true
                      subscribes:
                        -
                          id: 123
                          userId: 123
                          subscriberId: 123
                          date: '2025-01-01T01:01:01+00:00'
                          duration: 360
                          startDate: '2025-01-01T01:01:01+00:00'
                          expireDate: '2025-01-01T01:01:01+00:00'
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: '2025-01-01T01:01:01+00:00'
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '7 days'
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canCreatePromotion: true
                    canCreateTrial: true
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    finishedStreamsCount: 0
                    shouldShowFinishedStreams: false
                    hasSavedStreams: false
                    firstPublishedPostDate: '2025-01-01T01:01:01+00:00'
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: true
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999834
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: true
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: true
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          -
                            id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ''
                      notice:
                        type: string
                        example: ''
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: '7 days'
                      listsStates:
                        type: array
                        example:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      joinDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: About
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: null
                      wishlist:
                        type: string
                        example: null
                      location:
                        type: string
                        example: location
                      postsCount:
                        type: integer
                        example: 123
                      archivedPostsCount:
                        type: integer
                        example: 1
                      privateArchivedPostsCount:
                        type: integer
                        example: 123
                      photosCount:
                        type: integer
                        example: 123
                      videosCount:
                        type: integer
                        example: 63
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 123
                      lastSeen:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      favoritesCount:
                        type: integer
                        example: 123
                      favoritedCount:
                        type: integer
                        example: 123
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: 'Set to Expire'
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '2 months'
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              -
                                id: 123
                                userId: 123
                                subscriberId: 123
                                date: '2025-01-01T01:01:01+00:00'
                                duration: 360
                                startDate: '2025-01-01T01:01:01+00:00'
                                expireDate: '2025-01-01T01:01:01+00:00'
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: '2025-01-01T01:01:01+00:00'
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                duration:
                                  type: integer
                                  example: 360
                                startDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                expireDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                cancelDate:
                                  type: string
                                  example: null
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                offerEnd:
                                  type: string
                                  example: null
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '7 days'
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canCreatePromotion:
                        type: boolean
                        example: true
                      canCreateTrial:
                        type: boolean
                        example: true
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      finishedStreamsCount:
                        type: integer
                        example: 0
                      shouldShowFinishedStreams:
                        type: boolean
                        example: false
                      hasSavedStreams:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: true
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999834
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Users
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: user_id
        description: 'The OnlyFans ID of the user to restrict.'
        example: 123
        required: true
        schema:
          type: string
  '/api/{account}/users/{user_id}/block':
    post:
      summary: 'Block User'
      operationId: blockUser
      description: 'Block user from accessing your profile.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                    header: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: true
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: true
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      -
                        id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ''
                    notice: ''
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: '7 days'
                    listsStates:
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    joinDate: '2025-01-01T01:01:01+00:00'
                    isReferrerAllowed: true
                    about: About
                    isMarkdownDisabledForAbout: true
                    website: null
                    wishlist: null
                    location: location
                    postsCount: 123
                    archivedPostsCount: 1
                    privateArchivedPostsCount: 123
                    photosCount: 123
                    videosCount: 63
                    audiosCount: 0
                    mediasCount: 123
                    lastSeen: '2025-01-01T01:01:01+00:00'
                    favoritesCount: 123
                    favoritedCount: 123
                    showPostsInFeed: true
                    canReceiveChatMessage: true
                    isPerformer: true
                    isRealPerformer: true
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: 'Set to Expire'
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '2 months'
                      showPostsInFeed: true
                      subscribes:
                        -
                          id: 123
                          userId: 123
                          subscriberId: 123
                          date: '2025-01-01T01:01:01+00:00'
                          duration: 360
                          startDate: '2025-01-01T01:01:01+00:00'
                          expireDate: '2025-01-01T01:01:01+00:00'
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: '2025-01-01T01:01:01+00:00'
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '7 days'
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canCreatePromotion: true
                    canCreateTrial: true
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    finishedStreamsCount: 0
                    shouldShowFinishedStreams: false
                    hasSavedStreams: false
                    firstPublishedPostDate: '2025-01-01T01:01:01+00:00'
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: true
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999834
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: true
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: true
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          -
                            id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ''
                      notice:
                        type: string
                        example: ''
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: '7 days'
                      listsStates:
                        type: array
                        example:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      joinDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: About
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: null
                      wishlist:
                        type: string
                        example: null
                      location:
                        type: string
                        example: location
                      postsCount:
                        type: integer
                        example: 123
                      archivedPostsCount:
                        type: integer
                        example: 1
                      privateArchivedPostsCount:
                        type: integer
                        example: 123
                      photosCount:
                        type: integer
                        example: 123
                      videosCount:
                        type: integer
                        example: 63
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 123
                      lastSeen:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      favoritesCount:
                        type: integer
                        example: 123
                      favoritedCount:
                        type: integer
                        example: 123
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: 'Set to Expire'
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '2 months'
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              -
                                id: 123
                                userId: 123
                                subscriberId: 123
                                date: '2025-01-01T01:01:01+00:00'
                                duration: 360
                                startDate: '2025-01-01T01:01:01+00:00'
                                expireDate: '2025-01-01T01:01:01+00:00'
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: '2025-01-01T01:01:01+00:00'
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                duration:
                                  type: integer
                                  example: 360
                                startDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                expireDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                cancelDate:
                                  type: string
                                  example: null
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                offerEnd:
                                  type: string
                                  example: null
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '7 days'
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canCreatePromotion:
                        type: boolean
                        example: true
                      canCreateTrial:
                        type: boolean
                        example: true
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      finishedStreamsCount:
                        type: integer
                        example: 0
                      shouldShowFinishedStreams:
                        type: boolean
                        example: false
                      hasSavedStreams:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: true
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999834
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Users
    delete:
      summary: 'Unblock User'
      operationId: unblockUser
      description: 'Unblock a previously blocked user.'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                    header: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                    headerSize:
                      width: 4386
                      height: 1224
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: true
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: true
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: true
                    subscribePrice: 12.99
                    subscriptionBundles:
                      -
                        id: 123
                        discount: 50
                        duration: 3
                        price: 19.49
                        canBuy: true
                    displayName: ''
                    notice: ''
                    isPaywallRequired: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                    subscribedByAutoprolong: false
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: null
                    subscribedOnExpiredNow: true
                    subscribedOnDuration: '7 days'
                    listsStates:
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    joinDate: '2025-01-01T01:01:01+00:00'
                    isReferrerAllowed: true
                    about: About
                    isMarkdownDisabledForAbout: true
                    website: null
                    wishlist: null
                    location: location
                    postsCount: 123
                    archivedPostsCount: 1
                    privateArchivedPostsCount: 123
                    photosCount: 123
                    videosCount: 63
                    audiosCount: 0
                    mediasCount: 123
                    lastSeen: '2025-01-01T01:01:01+00:00'
                    favoritesCount: 123
                    favoritedCount: 123
                    showPostsInFeed: true
                    canReceiveChatMessage: true
                    isPerformer: true
                    isRealPerformer: true
                    isSpotifyConnected: false
                    subscribersCount: null
                    hasPinnedPosts: true
                    hasLabels: true
                    canChat: true
                    avatarHeaderConverterUpload: true
                    isPrivateRestriction: false
                    showSubscribersCount: false
                    showMediaCount: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 12.99
                      subscribePrice: 12.99
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: 'Set to Expire'
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '2 months'
                      showPostsInFeed: true
                      subscribes:
                        -
                          id: 123
                          userId: 123
                          subscriberId: 123
                          date: '2025-01-01T01:01:01+00:00'
                          duration: 360
                          startDate: '2025-01-01T01:01:01+00:00'
                          expireDate: '2025-01-01T01:01:01+00:00'
                          cancelDate: null
                          price: 0
                          regularPrice: 12.99
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: trial
                          offerStart: '2025-01-01T01:01:01+00:00'
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: null
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: '7 days'
                      tipsSumm: 0
                      subscribesSumm: 0
                      messagesSumm: 0
                      postsSumm: 0
                      streamsSumm: 0
                      totalSumm: 0
                      subscribes: []
                      hasActivePaidSubscriptions: false
                    canCreatePromotion: true
                    canCreateTrial: true
                    isAdultContent: false
                    canTrialSend: false
                    hasLinks: false
                    hasFriends: false
                    finishedStreamsCount: 0
                    shouldShowFinishedStreams: false
                    hasSavedStreams: false
                    firstPublishedPostDate: '2025-01-01T01:01:01+00:00'
                    isSpringConnected: false
                    isFriend: false
                    isBlocked: false
                    canReport: true
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999834
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 10000000
                      limit_day: 50000
                      remaining_minute: 9999999
                      remaining_day: 49992
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 4386
                          height:
                            type: integer
                            example: 1224
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: true
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: true
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: true
                      subscribePrice:
                        type: number
                        example: 12.99
                      subscriptionBundles:
                        type: array
                        example:
                          -
                            id: 123
                            discount: 50
                            duration: 3
                            price: 19.49
                            canBuy: true
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            discount:
                              type: integer
                              example: 50
                            duration:
                              type: integer
                              example: 3
                            price:
                              type: number
                              example: 19.49
                            canBuy:
                              type: boolean
                              example: true
                      displayName:
                        type: string
                        example: ''
                      notice:
                        type: string
                        example: ''
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      subscribedByAutoprolong:
                        type: boolean
                        example: false
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: string
                        example: null
                      subscribedOnExpiredNow:
                        type: boolean
                        example: true
                      subscribedOnDuration:
                        type: string
                        example: '7 days'
                      listsStates:
                        type: array
                        example:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      joinDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isReferrerAllowed:
                        type: boolean
                        example: true
                      about:
                        type: string
                        example: About
                      isMarkdownDisabledForAbout:
                        type: boolean
                        example: true
                      website:
                        type: string
                        example: null
                      wishlist:
                        type: string
                        example: null
                      location:
                        type: string
                        example: location
                      postsCount:
                        type: integer
                        example: 123
                      archivedPostsCount:
                        type: integer
                        example: 1
                      privateArchivedPostsCount:
                        type: integer
                        example: 123
                      photosCount:
                        type: integer
                        example: 123
                      videosCount:
                        type: integer
                        example: 63
                      audiosCount:
                        type: integer
                        example: 0
                      mediasCount:
                        type: integer
                        example: 123
                      lastSeen:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      favoritesCount:
                        type: integer
                        example: 123
                      favoritedCount:
                        type: integer
                        example: 123
                      showPostsInFeed:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      isSpotifyConnected:
                        type: boolean
                        example: false
                      subscribersCount:
                        type: string
                        example: null
                      hasPinnedPosts:
                        type: boolean
                        example: true
                      hasLabels:
                        type: boolean
                        example: true
                      canChat:
                        type: boolean
                        example: true
                      avatarHeaderConverterUpload:
                        type: boolean
                        example: true
                      isPrivateRestriction:
                        type: boolean
                        example: false
                      showSubscribersCount:
                        type: boolean
                        example: false
                      showMediaCount:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: number
                            example: 12.99
                          subscribePrice:
                            type: number
                            example: 12.99
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: 'Set to Expire'
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '2 months'
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              -
                                id: 123
                                userId: 123
                                subscriberId: 123
                                date: '2025-01-01T01:01:01+00:00'
                                duration: 360
                                startDate: '2025-01-01T01:01:01+00:00'
                                expireDate: '2025-01-01T01:01:01+00:00'
                                cancelDate: null
                                price: 0
                                regularPrice: 12.99
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: trial
                                offerStart: '2025-01-01T01:01:01+00:00'
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                duration:
                                  type: integer
                                  example: 360
                                startDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                expireDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                cancelDate:
                                  type: string
                                  example: null
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: number
                                  example: 12.99
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: trial
                                offerStart:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                offerEnd:
                                  type: string
                                  example: null
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: null
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: '7 days'
                          tipsSumm:
                            type: integer
                            example: 0
                          subscribesSumm:
                            type: integer
                            example: 0
                          messagesSumm:
                            type: integer
                            example: 0
                          postsSumm:
                            type: integer
                            example: 0
                          streamsSumm:
                            type: integer
                            example: 0
                          totalSumm:
                            type: integer
                            example: 0
                          subscribes:
                            type: array
                            example: []
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      canCreatePromotion:
                        type: boolean
                        example: true
                      canCreateTrial:
                        type: boolean
                        example: true
                      isAdultContent:
                        type: boolean
                        example: false
                      canTrialSend:
                        type: boolean
                        example: false
                      hasLinks:
                        type: boolean
                        example: false
                      hasFriends:
                        type: boolean
                        example: false
                      finishedStreamsCount:
                        type: integer
                        example: 0
                      shouldShowFinishedStreams:
                        type: boolean
                        example: false
                      hasSavedStreams:
                        type: boolean
                        example: false
                      firstPublishedPostDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isSpringConnected:
                        type: boolean
                        example: false
                      isFriend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canReport:
                        type: boolean
                        example: true
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999834
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 10000000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 9999999
                          remaining_day:
                            type: integer
                            example: 49992
      tags:
        - Users
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: user_id
        description: 'The OnlyFans ID of the user to block.'
        example: 123
        required: true
        schema:
          type: string
  '/api/{account}/users/{user_id}/subscribe':
    post:
      summary: 'Subscribe to User'
      operationId: subscribeToUser
      description: "Subscribe to a user's profile."
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    view: f
                    avatar: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                    avatarThumbs:
                      c50: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                      c144: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                    header: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                    headerSize:
                      width: 3840
                      height: 1197
                    headerThumbs:
                      w480: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                      w760: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                    id: 123
                    name: name
                    username: username
                    canLookStory: true
                    canCommentStory: true
                    hasNotViewedStory: true
                    isVerified: true
                    canPayInternal: true
                    hasScheduledStream: false
                    hasStream: false
                    hasStories: true
                    tipsEnabled: true
                    tipsTextEnabled: true
                    tipsMin: 5
                    tipsMinInternal: 1
                    tipsMax: 200
                    canEarn: true
                    canAddSubscriber: false
                    subscribePrice: 0
                    isPaywallRequired: true
                    isActive: true
                    isRestricted: false
                    canRestrict: true
                    subscribedBy: true
                    subscribedByExpire: false
                    subscribedByExpireDate: '2025-01-01T01:01:01+00:00'
                    subscribedByAutoprolong: true
                    subscribedIsExpiredNow: false
                    currentSubscribePrice: 0
                    subscribedOn: false
                    subscribedOnExpiredNow: null
                    subscribedOnDuration: null
                    listsStates:
                      -
                        id: following
                        type: following
                        name: Following
                        hasUser: true
                        canAddUser: false
                        cannotAddUserReason: ALREADY_EXISTS
                      -
                        id: fans
                        type: fans
                        name: Fans
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: rebill_off
                        type: rebill_off
                        name: 'Renew Off'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: rebill_on
                        type: rebill_on
                        name: 'Renew On'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: null
                      -
                        id: recent
                        type: recent
                        name: 'Recent (last 24 hours)'
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: tagged
                        type: tagged
                        name: Tagged
                        hasUser: false
                        canAddUser: false
                        cannotAddUserReason: SYSTEM_LIST
                      -
                        id: friends
                        type: friends
                        name: Friends
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                      -
                        id: muted
                        type: muted
                        name: Muted
                        hasUser: false
                        canAddUser: true
                        cannotAddUserReason: null
                    canReport: true
                    canReceiveChatMessage: true
                    hideChat: false
                    lastSeen: '2025-01-01T01:01:01+00:00'
                    isPerformer: true
                    isRealPerformer: true
                    subscribedByData:
                      price: 0
                      newPrice: 0
                      regularPrice: 0
                      subscribePrice: 0
                      discountPercent: 0
                      discountPeriod: 1
                      subscribeAt: '2025-01-01T01:01:01+00:00'
                      expiredAt: '2025-01-01T01:01:01+00:00'
                      renewedAt: '2025-01-01T01:01:01+00:00'
                      discountFinishedAt: null
                      discountStartedAt: null
                      status: null
                      isMuted: false
                      unsubscribeReason: 'No reason given'
                      duration: ''
                      showPostsInFeed: true
                      subscribes:
                        -
                          id: 123
                          userId: 123
                          subscriberId: 123
                          date: '2025-01-01T01:01:01+00:00'
                          duration: 3652
                          startDate: '2025-01-01T01:01:01+00:00'
                          expireDate: '2025-01-01T01:01:01+00:00'
                          cancelDate: null
                          price: 0
                          regularPrice: 0
                          discount: 0
                          earningId: 0
                          action: subscribe
                          type: regular
                          offerStart: null
                          offerEnd: null
                          isCurrent: true
                      hasActivePaidSubscriptions: false
                    subscribedOnData: null
                    canTrialSend: false
                    isBlocked: false
                    canUnsubscribe: true
                    isPendingAutoprolong: false
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999834
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49971
                properties:
                  data:
                    type: object
                    properties:
                      view:
                        type: string
                        example: f
                      avatar:
                        type: string
                        example: 'https://public.onlyfans.com/files/i/i2/i25/.../123/avatar.jpg'
                      avatarThumbs:
                        type: object
                        properties:
                          c50:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c50/i/i2/i25/.../123/avatar.jpg'
                          c144:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/c144/i/i2/i25/.../123/avatar.jpg'
                      header:
                        type: string
                        example: 'https://public.onlyfans.com/files/c/cs/cse/.../123/header_image.jpg'
                      headerSize:
                        type: object
                        properties:
                          width:
                            type: integer
                            example: 3840
                          height:
                            type: integer
                            example: 1197
                      headerThumbs:
                        type: object
                        properties:
                          w480:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w480/c/cs/cse/.../123/header_image.jpg'
                          w760:
                            type: string
                            example: 'https://thumbs.onlyfans.com/public/files/thumbs/w760/c/cs/cse/.../123/header_image.jpg'
                      id:
                        type: integer
                        example: 123
                      name:
                        type: string
                        example: name
                      username:
                        type: string
                        example: username
                      canLookStory:
                        type: boolean
                        example: true
                      canCommentStory:
                        type: boolean
                        example: true
                      hasNotViewedStory:
                        type: boolean
                        example: true
                      isVerified:
                        type: boolean
                        example: true
                      canPayInternal:
                        type: boolean
                        example: true
                      hasScheduledStream:
                        type: boolean
                        example: false
                      hasStream:
                        type: boolean
                        example: false
                      hasStories:
                        type: boolean
                        example: true
                      tipsEnabled:
                        type: boolean
                        example: true
                      tipsTextEnabled:
                        type: boolean
                        example: true
                      tipsMin:
                        type: integer
                        example: 5
                      tipsMinInternal:
                        type: integer
                        example: 1
                      tipsMax:
                        type: integer
                        example: 200
                      canEarn:
                        type: boolean
                        example: true
                      canAddSubscriber:
                        type: boolean
                        example: false
                      subscribePrice:
                        type: integer
                        example: 0
                      isPaywallRequired:
                        type: boolean
                        example: true
                      isActive:
                        type: boolean
                        example: true
                      isRestricted:
                        type: boolean
                        example: false
                      canRestrict:
                        type: boolean
                        example: true
                      subscribedBy:
                        type: boolean
                        example: true
                      subscribedByExpire:
                        type: boolean
                        example: false
                      subscribedByExpireDate:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      subscribedByAutoprolong:
                        type: boolean
                        example: true
                      subscribedIsExpiredNow:
                        type: boolean
                        example: false
                      currentSubscribePrice:
                        type: integer
                        example: 0
                      subscribedOn:
                        type: boolean
                        example: false
                      subscribedOnExpiredNow:
                        type: string
                        example: null
                      subscribedOnDuration:
                        type: string
                        example: null
                      listsStates:
                        type: array
                        example:
                          -
                            id: following
                            type: following
                            name: Following
                            hasUser: true
                            canAddUser: false
                            cannotAddUserReason: ALREADY_EXISTS
                          -
                            id: fans
                            type: fans
                            name: Fans
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: rebill_off
                            type: rebill_off
                            name: 'Renew Off'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: rebill_on
                            type: rebill_on
                            name: 'Renew On'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: null
                          -
                            id: recent
                            type: recent
                            name: 'Recent (last 24 hours)'
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: tagged
                            type: tagged
                            name: Tagged
                            hasUser: false
                            canAddUser: false
                            cannotAddUserReason: SYSTEM_LIST
                          -
                            id: friends
                            type: friends
                            name: Friends
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                          -
                            id: muted
                            type: muted
                            name: Muted
                            hasUser: false
                            canAddUser: true
                            cannotAddUserReason: null
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: following
                            type:
                              type: string
                              example: following
                            name:
                              type: string
                              example: Following
                            hasUser:
                              type: boolean
                              example: true
                            canAddUser:
                              type: boolean
                              example: false
                            cannotAddUserReason:
                              type: string
                              example: ALREADY_EXISTS
                      canReport:
                        type: boolean
                        example: true
                      canReceiveChatMessage:
                        type: boolean
                        example: true
                      hideChat:
                        type: boolean
                        example: false
                      lastSeen:
                        type: string
                        example: '2025-01-01T01:01:01+00:00'
                      isPerformer:
                        type: boolean
                        example: true
                      isRealPerformer:
                        type: boolean
                        example: true
                      subscribedByData:
                        type: object
                        properties:
                          price:
                            type: integer
                            example: 0
                          newPrice:
                            type: integer
                            example: 0
                          regularPrice:
                            type: integer
                            example: 0
                          subscribePrice:
                            type: integer
                            example: 0
                          discountPercent:
                            type: integer
                            example: 0
                          discountPeriod:
                            type: integer
                            example: 1
                          subscribeAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          expiredAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          renewedAt:
                            type: string
                            example: '2025-01-01T01:01:01+00:00'
                          discountFinishedAt:
                            type: string
                            example: null
                          discountStartedAt:
                            type: string
                            example: null
                          status:
                            type: string
                            example: null
                          isMuted:
                            type: boolean
                            example: false
                          unsubscribeReason:
                            type: string
                            example: 'No reason given'
                          duration:
                            type: string
                            example: ''
                          showPostsInFeed:
                            type: boolean
                            example: true
                          subscribes:
                            type: array
                            example:
                              -
                                id: 123
                                userId: 123
                                subscriberId: 123
                                date: '2025-01-01T01:01:01+00:00'
                                duration: 3652
                                startDate: '2025-01-01T01:01:01+00:00'
                                expireDate: '2025-01-01T01:01:01+00:00'
                                cancelDate: null
                                price: 0
                                regularPrice: 0
                                discount: 0
                                earningId: 0
                                action: subscribe
                                type: regular
                                offerStart: null
                                offerEnd: null
                                isCurrent: true
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 123
                                userId:
                                  type: integer
                                  example: 123
                                subscriberId:
                                  type: integer
                                  example: 123
                                date:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                duration:
                                  type: integer
                                  example: 3652
                                startDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                expireDate:
                                  type: string
                                  example: '2025-01-01T01:01:01+00:00'
                                cancelDate:
                                  type: string
                                  example: null
                                price:
                                  type: integer
                                  example: 0
                                regularPrice:
                                  type: integer
                                  example: 0
                                discount:
                                  type: integer
                                  example: 0
                                earningId:
                                  type: integer
                                  example: 0
                                action:
                                  type: string
                                  example: subscribe
                                type:
                                  type: string
                                  example: regular
                                offerStart:
                                  type: string
                                  example: null
                                offerEnd:
                                  type: string
                                  example: null
                                isCurrent:
                                  type: boolean
                                  example: true
                          hasActivePaidSubscriptions:
                            type: boolean
                            example: false
                      subscribedOnData:
                        type: string
                        example: null
                      canTrialSend:
                        type: boolean
                        example: false
                      isBlocked:
                        type: boolean
                        example: false
                      canUnsubscribe:
                        type: boolean
                        example: true
                      isPendingAutoprolong:
                        type: boolean
                        example: false
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999834
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49971
      tags:
        - Users
    delete:
      summary: 'Unsubscribe from User'
      operationId: unsubscribeFromUser
      description: "Unsubscribe from a user's profile."
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    success: true
                    message: Unsubscribed
                  _meta:
                    _credits:
                      used: 1
                      balance: 999999
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                properties:
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                        example: true
                      message:
                        type: string
                        example: Unsubscribed
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 1
                          balance:
                            type: integer
                            example: 999999
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
      tags:
        - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                reason:
                  type: string
                  description: 'Reason for unsubscribing. Valid options: `1,2,3,4,5`. Leave empty for `No specific reason`.'
                  example: null
              required:
                - reason
    parameters:
      -
        in: path
        name: account
        description: 'The Account ID'
        example: acct_XXXXXXXXXXXXXXX
        required: true
        schema:
          type: string
      -
        in: path
        name: user_id
        description: 'The OnlyFans ID of the user to subscribe to.'
        example: 123
        required: true
        schema:
          type: string
  /api/webhooks/events:
    get:
      summary: 'List Available Events'
      operationId: listAvailableEvents
      description: 'Retrieve a list of all available webhook event types'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      value: messages.received
                      description: 'Message received'
                    -
                      value: messages.sent
                      description: 'Message sent'
                    -
                      value: messages.ppv.unlocked
                      description: 'PPV message purchased'
                    -
                      value: subscriptions.new
                      description: 'New subscription'
                    -
                      value: users.typing
                      description: 'User typing'
                    -
                      value: posts.liked
                      description: 'Post liked'
                    -
                      value: accounts.connected
                      description: 'Account connected'
                    -
                      value: accounts.reconnected
                      description: 'Account reconnected'
                    -
                      value: accounts.session_expired
                      description: 'Account session expired'
                    -
                      value: accounts.authentication_failed
                      description: 'Account authentication failed'
                    -
                      value: accounts.otp_code_required
                      description: 'OTP code required'
                    -
                      value: accounts.face_otp_required
                      description: 'Face OTP required'
                  _meta:
                    _credits:
                      used: 0
                      balance: 1000000016
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 999
                      remaining_day: 49975
                properties:
                  data:
                    type: array
                    example:
                      -
                        value: messages.received
                        description: 'Message received'
                      -
                        value: messages.sent
                        description: 'Message sent'
                      -
                        value: messages.ppv.unlocked
                        description: 'PPV message purchased'
                      -
                        value: subscriptions.new
                        description: 'New subscription'
                      -
                        value: users.typing
                        description: 'User typing'
                      -
                        value: posts.liked
                        description: 'Post liked'
                      -
                        value: accounts.connected
                        description: 'Account connected'
                      -
                        value: accounts.reconnected
                        description: 'Account reconnected'
                      -
                        value: accounts.session_expired
                        description: 'Account session expired'
                      -
                        value: accounts.authentication_failed
                        description: 'Account authentication failed'
                      -
                        value: accounts.otp_code_required
                        description: 'OTP code required'
                      -
                        value: accounts.face_otp_required
                        description: 'Face OTP required'
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          example: messages.received
                        description:
                          type: string
                          example: 'Message received'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 1000000016
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 999
                          remaining_day:
                            type: integer
                            example: 49975
      tags:
        - Webhooks
  /api/webhooks:
    get:
      summary: 'List Webhooks'
      operationId: listWebhooks
      description: 'Retrieve a list of webhooks for your Team'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: wh_abc123
                      url: 'https://example.com'
                      events:
                        - accounts.connected
                        - subscriptions.new
                      has_signing_secret: true
                      enabled: false
                      created_at: '2025-01-01T00:00:00.000000Z'
                  _meta:
                    _credits:
                      used: 0
                      balance: 1000000016
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49996
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: wh_abc123
                        url: 'https://example.com'
                        events:
                          - accounts.connected
                          - subscriptions.new
                        has_signing_secret: true
                        enabled: false
                        created_at: '2025-01-01T00:00:00.000000Z'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: wh_abc123
                        url:
                          type: string
                          example: 'https://example.com'
                        events:
                          type: array
                          example:
                            - accounts.connected
                            - subscriptions.new
                          items:
                            type: string
                        has_signing_secret:
                          type: boolean
                          example: true
                        enabled:
                          type: boolean
                          example: false
                        created_at:
                          type: string
                          example: '2025-01-01T00:00:00.000000Z'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 1000000016
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49996
      tags:
        - Webhooks
    post:
      summary: 'Create Webhook'
      operationId: createWebhook
      description: 'Create a new webhook for your Team'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: wh_abc123
                    url: 'https://example.com'
                    events:
                      - accounts.connected
                      - subscriptions.new
                    has_signing_secret: true
                    enabled: false
                    created_at: '2025-01-01T00:00:00.000000Z'
                  _meta:
                    _credits:
                      used: 0
                      balance: 1000000016
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 998
                      remaining_day: 49998
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: wh_abc123
                      url:
                        type: string
                        example: 'https://example.com'
                      events:
                        type: array
                        example:
                          - accounts.connected
                          - subscriptions.new
                        items:
                          type: string
                      has_signing_secret:
                        type: boolean
                        example: true
                      enabled:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        example: '2025-01-01T00:00:00.000000Z'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 1000000016
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 998
                          remaining_day:
                            type: integer
                            example: 49998
      tags:
        - Webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                endpoint_url:
                  type: string
                  description: 'The URL of your webhook endpoint.'
                  example: 'https://example.com'
                signing_secret:
                  type: string
                  description: 'Optionally, add a signing secret to protect your webhook.'
                  example: 7
                  nullable: true
                events:
                  type: array
                  description: 'An array of webhook events to subscribe to. For all options, refer to our **List Available Events** endpoint.'
                  example:
                    - accounts.connected
                    - subscriptions.new
                  items:
                    type: string
                account_scope:
                  type: string
                  description: 'The account scope for the webhook. Use "global" for all accounts, "inclusive" for only selected accounts, or "exclusive" for all except selected accounts.'
                  example: global
                account_ids:
                  type: array
                  description: 'An array of account IDs to apply the scope to. Required unless account_scope is "global".'
                  example:
                    - ac_abc123
                  items:
                    type: string
              required:
                - endpoint_url
                - events
                - account_scope
  '/api/webhooks/{webhook_id}':
    get:
      summary: 'Show Webhook'
      operationId: showWebhook
      description: 'Retrieve details about a specific webhook'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: wh_abc123
                    url: 'https://example.com'
                    events:
                      - accounts.connected
                      - subscriptions.new
                    has_signing_secret: true
                    enabled: false
                    created_at: '2025-01-01T00:00:00.000000Z'
                  _meta:
                    _credits:
                      used: 0
                      balance: 1000000016
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: wh_abc123
                      url:
                        type: string
                        example: 'https://example.com'
                      events:
                        type: array
                        example:
                          - accounts.connected
                          - subscriptions.new
                        items:
                          type: string
                      has_signing_secret:
                        type: boolean
                        example: true
                      enabled:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        example: '2025-01-01T00:00:00.000000Z'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 1000000016
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Webhooks
    put:
      summary: 'Update Webhook'
      operationId: updateWebhook
      description: 'Update an existing webhook'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: wh_abc123
                    url: 'https://example.com'
                    events:
                      - accounts.connected
                      - subscriptions.new
                    has_signing_secret: true
                    enabled: false
                    created_at: '2025-01-01T00:00:00.000000Z'
                  _meta:
                    _credits:
                      used: 0
                      balance: 1000000016
                      note: Always
                    _cache:
                      is_cached: false
                      note: 'Cache disabled for this endpoint'
                    _rate_limits:
                      limit_minute: 1000
                      limit_day: 50000
                      remaining_minute: 996
                      remaining_day: 49990
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: wh_abc123
                      url:
                        type: string
                        example: 'https://example.com'
                      events:
                        type: array
                        example:
                          - accounts.connected
                          - subscriptions.new
                        items:
                          type: string
                      has_signing_secret:
                        type: boolean
                        example: true
                      enabled:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        example: '2025-01-01T00:00:00.000000Z'
                  _meta:
                    type: object
                    properties:
                      _credits:
                        type: object
                        properties:
                          used:
                            type: integer
                            example: 0
                          balance:
                            type: integer
                            example: 1000000016
                          note:
                            type: string
                            example: Always
                      _cache:
                        type: object
                        properties:
                          is_cached:
                            type: boolean
                            example: false
                          note:
                            type: string
                            example: 'Cache disabled for this endpoint'
                      _rate_limits:
                        type: object
                        properties:
                          limit_minute:
                            type: integer
                            example: 1000
                          limit_day:
                            type: integer
                            example: 50000
                          remaining_minute:
                            type: integer
                            example: 996
                          remaining_day:
                            type: integer
                            example: 49990
      tags:
        - Webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                endpoint_url:
                  type: string
                  description: 'The URL of your webhook endpoint.'
                  example: 'https://example.com'
                events:
                  type: array
                  description: 'An array of webhook events to subscribe to. For all options, refer to our **List Available Events** endpoint.'
                  example:
                    - accounts.connected
                    - subscriptions.new
                  items:
                    type: string
                enabled:
                  type: boolean
                  description: 'Optionally, enabled/disable the webhook. This will stop/resume the sending of events, without having to delete the webhook.'
                  example: true
                  nullable: true
                account_scope:
                  type: string
                  description: 'The account scope for the webhook. Use "global" for all accounts, "inclusive" for only selected accounts, or "exclusive" for all except selected accounts.'
                  example: global
                account_ids:
                  type: array
                  description: 'An array of account IDs to apply the scope to. Required unless account_scope is "global".'
                  example:
                    - ac_abc123
                  items:
                    type: string
              required:
                - endpoint_url
                - events
                - account_scope
    delete:
      summary: 'Delete Webhook'
      operationId: deleteWebhook
      description: 'Delete an existing webhook'
      parameters: []
      responses:
        204:
          description: 'Successfully deleted'
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Webhooks
    parameters:
      -
        in: path
        name: webhook_id
        description: 'The ID of the webhook'
        example: wh_abc123
        required: true
        schema:
          type: string
