Read the org's billing state
Its plan and where it stands with billing: free, on a trial (and when it ends, whether a card is on file to carry on, and a payment to end it now that waits for the bank's confirmation), paying, past due, or set to end at the period's end and move to the free plan; a downgrade waiting for the period's end (a trial's, on a trial), never beside an end; and whether a trial is still open to it. Needs `org.billing.view`.
/v1/orgs/{org}/billingIts plan and where it stands with billing: free, on a trial (and when it ends, whether a card is on file to carry on, and a payment to end it now that waits for the bank's confirmation), paying, past due, or set to end at the period's end and move to the free plan; a downgrade waiting for the period's end (a trial's, on a trial), never beside an end; and whether a trial is still open to it. Needs org.billing.view.
Authorization
bearer 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
The org's id
^org_[0-9a-hjkmnp-tv-z]{26}$Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/billing" \ -H "Authorization: Bearer $SYNQ_API_KEY"{ "plan": "pro", "status": "trialing", "interval": "month", "trial_ends_at": "2026-11-04T16:00:00.000Z", "current_period_end": "2026-10-21T12:00:00.000Z", "cancel_at": "2026-11-22T16:00:00.000Z", "scheduled_change": { "plan": "string", "interval": "month", "at": "2026-10-21T12:00:00.000Z" }, "called_off_change": { "plan": "string", "interval": "month" }, "card_on_file": true, "payment_requires_action": { "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1Abc/test_YWNj", "invoice": { "id": "in_1Abc", "number": "SYNQ-0001", "status": "paid", "currency": "usd", "total_cents": "2500", "amount_due_cents": "2500", "created": "2026-10-04T16:00:00.000Z", "period_start": "2026-10-21T12:00:00.000Z", "period_end": "2026-10-21T12:00:00.000Z", "hosted_invoice_url": "https://example.com", "invoice_pdf": "https://example.com" }, "expires_at": "2026-11-17T16:00:00.000Z", "change": "change_plan", "plan": "scale", "interval": "month" }, "trial_available": true}Read the org's usage GET
Its monthly active users in a month against its plan's allowance (never refused; above it each is billed at the plan's overage price, and on a plan with none, such as free Starter, nothing is), and its apps and brands against the plan's limits, with the apps that hold the plan's places (`apps.held_by`), so a full plan can be said, naming them, before a new app is refused. 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, as they did while active. Needs `org.billing.view`.
List who left an org GET
Everyone who left the org or was removed from it and isn't a member again, newest first: who they were, the role they had, when they joined and left, and whether they left themselves or who removed them. Read from the audit log's `member.left` and `member.removed` entries, so it reaches as far back as the org's plan keeps its log (`audit_retention_days` in `GET /v1/plans`). Their access ended when they went; filter the audit log by their `user_id` (`actor`) to see what they did. Needs `org.members.view`.