Earnings and payout endpoints are creator-only — a fan account receives
403.| Resource | What it covers |
|---|---|
of.earnings | Chart, transactions, balances, payout requests, today-activity, top-posts / top-fans / top-stories / top-streams / top-messages, fans-activity feed, per-post / per-story stats. |
of.payments | Cards, transactions, withdraw, VAT methods, 3DS config, CCBill token, alternative methods. |
of.payouts | Bank / Stripe balances and requests, DAC7, W-9, VAT documents, UK company data, monthly invoice downloads. |
of.chargebacks | Inbound chargebacks list. |
of.dataExports | Async export workflow: create / get / list / cancel / start, plus waitForCompletion(id). |
Recipes
const balances = await of.earnings.balances();
const chart = await of.earnings.chart({
startDate: "2026-01-01",
endDate: "2026-04-30",
});
const txs = await of.earnings.listTransactions({ limit: 100 });
// Bulk export
const job = await of.dataExports.create({ /* ... */ });
const done = await of.dataExports.waitForCompletion(job.id);