users

Get plan usage and limits

Return the plan's limits and consumption so far: scans used and remaining this calendar month, when the quota resets, which categories are available, and any one-off scan credits.

Quota runs on the calendar month in UTC and does not roll over.

get/users/me/usage

Request

  • Base URL: https://api.sytecheck.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.sytecheck.app/users/me/usage
  • Auth: HTTP bearer

Response

Successful Response

tierstring required

Billing tier: "free", "pro", or "agency".

plan_namestring required

Display name of the plan, e.g. "Pro".

scans_usedinteger required

Scans created in the current calendar month (UTC).

scans_limitinteger required

Scans the plan permits per calendar month.

scans_remaininginteger required

Scans left before the monthly cap is reached.

period_startstring date-time required

First instant of the current quota month (UTC).

period_endstring date-time required

When the quota resets (UTC).

categoriesstring[] required

Analysis categories this plan may run.

pdf_exportboolean required

Whether PDF report download is included.

public_apiboolean required

Whether API keys may be minted and used.

webhooksboolean required

Whether a scan may request webhook delivery.

retention_daysinteger required

How long completed scans are kept.

concurrent_scansinteger required

Maximum simultaneously running scans.

scan_creditsinteger

Unspent one-off scan credits. Each buys a single all-category scan outside the monthly quota, and is only spent on explicit request.

retention_grace_untilstring date-time nullable

When the extended retention granted after a plan downgrade ends. Until then scans are kept as though the account were still on its previous plan; after it, retention_days applies and older scans may be permanently deleted. Null when no grace period is running.

one_off_offer_price_usdstring nullable

A one-time reduced price for the one-off scan, applied automatically at checkout until one_off_offer_expires_at. Null when there is no offer.

one_off_offer_expires_atstring date-time nullable

When the one-time one-off scan price ends.

Changes

No recorded changes to this operation across all 1 revision of this API.