Synq Docs
Management APIOrgs

Read the org's usage

Its monthly active users in a month against its plan's allowance (above it each is billed, never refused), and its apps and brands against the plan's limits. A user is active in a month once they get tokens in it: signing in, or an app refreshing their tokens, so someone who stays signed in counts each month an app uses their session. Users deleted since still count: they were billed. Needs `org.billing.view`.

GET/v1/orgs/{org}/billing/usage

Its monthly active users in a month against its plan's allowance (above it each is billed, never refused), and its apps and brands against the plan's limits. A user is active in a month once they get tokens in it: signing in, or an app refreshing their tokens, so someone who stays signed in counts each month an app uses their session. Users deleted since still count: they were billed. Needs org.billing.view.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

Query Parameters

month?string

The calendar month, in UTC; this one when not given

Match^\d{4}-(0[1-9]|1[0-2])$

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/orgs/string/billing/usage"
{  "month": "string",  "plan": "string",  "monthly_active_users": {    "count": 0,    "included": 0,    "over": 0  },  "apps": {    "count": 0,    "limit": 0  },  "brands": {    "count": 0,    "limit": 0  }}