Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onlyfanskit.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Subscribers

The subscriptions resource covers your audience and per-subscriber state. 
const active = await of.subscriptions.listActive({ limit: 50 });
const expired = await of.subscriptions.listExpired();
const top = await of.subscriptions.topSubscribers();
const chart = await of.subscriptions.subscribersChart();
Want toCall
Active subscriberssubscriptions.listActive(params)
Expired subscriberssubscriptions.listExpired(params)
Everyonesubscriptions.listAll(params)
Top subscriberssubscriptions.topSubscribers()
Subscriber count over timesubscriptions.subscribersChart()
Apply a discountsubscriptions.applyDiscount(...)
Toggle auto-prolongsubscriptions.setAutoProlong(...)

​
Subscribing to a creator

await of.subscriptions.subscribe(creatorId);
// with a free-trial link:
await of.subscriptions.subscribe(creatorId, { trialId: 12345 });
// cancel auto-renewal (stays active until expiry):
await of.subscriptions.unsubscribe(creatorId);
A payment card must be on file for any subscribe call — even when the creator’s price is $0. Without one you’ll get a 400 with code 106.

​
Lists (audience segments)

Group fans into lists for targeted messaging and analytics. 
const my = await of.lists.create("VIP fans");
await of.lists.addUsers(my.id, [123, 456]);
const members = await of.lists.listUsers(my.id, { limit: 50 });
await of.lists.removeUser(my.id, 123);
Lists also support criteria-based bulk adds — addTopSubscribers, addAwardWinners, addQueueBuyers, addStreamSegment, and more — so you can build a segment from an existing cohort in one call.

​
Moderation

users.block, users.unblock, users.restrict, and users.unrestrict manage individual fan access. streaks exposes per-fan engagement streak counters.