API reference / Account
GET /v1/accountYour account: email, plan, password, billing and consent status
What the account page needs in one call. `email` is the caller's own address in full — it is their key or session asking. `billing_attached` says whether /v1/billing/portal has a subscription to open; `password_set` whether /v1/login works yet.
X-API-Key
0 credits
curl 'https://api.puntersedge.online/v1/account' \
-H 'X-API-Key: YOUR_KEY'
This endpoint takes no parameters beyond authentication.
Status codes: 200, 401, 402, 422, 429, 500. Response bodies are JSON; the full schema is in /openapi.json.
200 application/json
— this call costs 0 credits.
Field names and types are as the API returns them; values are a real sample, trimmed to a few items.
{
"email": "example@example.com",
"email_masked": "ex***@example.com",
"plan": "plus",
"plan_display": "Plus",
"password_set": true,
"password_set_at": "2026-09-28T04:12:09Z",
"billing_attached": true,
"is_team_key": false,
"team_keys_allowed": 1,
"created_at": "2026-08-14T09:30:11Z",
"key_version": 1,
"auth_via": "session",
"terms_accepted_at": "2026-08-14T09:30:11Z",
"marketing_opt_in": true,
"marketing_changed_at": "2026-08-14T09:30:11Z",
"email_suppressed": false,
"suppression_reason": null,
"login_url": "https://puntersedge.online/login",
"account_url": "https://puntersedge.online/account"
}
POST /v1/account/marketing — Turn promotional emails on or off for your accountPOST /v1/account/password — Set or change your account passwordGET /v1/billing/overage — Overage: state, rate and ceilingPOST /v1/billing/overage — Switch overage on or offGET /v1/billing/portal — Self-service billing portal linkPOST /v1/billing/portal — Billing portal link (console; confirms your password)GET /v1/billing/upgrade-link — A signed link to your prorated upgrade pagePOST /v1/billing/upgrade-link — Prorated upgrade link (console; confirms your password)The free tier needs no credit card, and the sandbox endpoints need no key at all.
Get a free API key Quickstart