GET /api/usage

Request	`GET /api/usage`
Authentication	Session cookie required
Handler	`backend/usage.py`

What it does

The account's tier and features, plus the referral multiplier and the cap on it. `counts_when` states the moment a referral is credited, so the number can be checked rather than trusted.

Authentication

Session cookie required. Send the ff_session cookie. Without one the engine treats the caller as a new visitor with no holds and no claims, and returns a new cookie to use from then on.

Parameters

Parameter	In	Type	Required	Description
`ff_session`	cookie	`string`	Optional	The session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims.

Request

The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.

cURLJavaScriptPython

curl -s -b cookies.txt -c cookies.txt \
  "https://flowfinds.ai/api/usage"

const res = await fetch("https://flowfinds.ai/api/usage", {
  method: "GET",
  credentials: "include",
});
const data = await res.json();

import requests

s = requests.Session()
r = s.get("https://flowfinds.ai/api/usage")
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  "$FLOWFINDS_ORIGIN/api/usage"

Responses

`200` — Always.

Field	Type	Description
`account`	`boolean`	Whether a subject account was resolved.
`tier`	`string`	The tier identifier.
`tier_label`	`string`	Its display label.
`features`	`object`	What the tier includes.
`referrals`	`object`	`qualified`, `multiplier`, `cap` and `counts_when`.

Errors

This endpoint has no failure path of its own. An uncaught exception anywhere in the engine is still returned as structured JSON by the shared guard.

GET /api/ad — The ad artifact for the session's product, with its pass criteria.
POST /api/ad/edit — Override the ad copy, or reset it to the generated version.
POST /api/growth/edit — Edit a growth artifact in natural language.
GET /api/ads-manager — The campaign book.
POST /api/ads-manager — Save the campaign book.
GET /api/adbalance — The advertising balance, its ledger and any pending top-ups.
POST /api/adbalance — Start a balance top-up.
GET /api/adbalance/confirm — Retired. Balance confirmation is no longer client-driven.

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.