GET/root/reports/ops-health
Report billing maintenance trouble
Operation root.reports.opsHealth.get
Description
Reports billing maintenance trouble across organizations: failing or overdue Stripe seat syncs, failed or overdue trial expiries, overdue purges, and trials and purges coming due. Only root operators may call it, and each request is recorded in the root audit trail.
Authentication
Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.
Responses
200 OK
application/jsonRootOpsHealthReportResponse
Billing maintenance trouble across organizations. Each section lists at most a bounded number of rows and says when it was truncated.
6 fields
generatedAtstringrequiredseatSyncobjectrequiredStripe seat syncs that are failing, overdue, or hold a lapsed lease, in retry order.
2 fields
rowslist of objectrequired- at most 50 items
9 fields
organizationIdstringrequired- not empty
conditionslist of stringrequired- at most 3 items
- each item: one of
failing,stalled,leaseExpired
attemptCountintegerrequired- at least 0
appliedRevisionintegerrequired- at least 0
desiredRevisionintegerrequired- at least 0
lastErrorstringrequirednullablelastSyncedAtstringrequirednullableleaseExpiresAtstringrequirednullablenextAttemptAtstringrequirednullable
Other fields are allowed.
truncatedbooleanrequired
Other fields are allowed.
trialExpiryobjectrequiredEnded trials the expiry sweep failed on or has not reached in time.
2 fields
rowslist of objectrequired- at most 50 items
6 fields
organizationIdstringrequired- not empty
trialEndsAtstringrequiredattemptCountintegerrequired- at least 0
lastErrorstringrequirednullablenextAttemptAtstringrequirednullablerequiresAttentionbooleanrequired
Other fields are allowed.
truncatedbooleanrequired
Other fields are allowed.
purgesobjectrequiredPurges past due to start, or started with a lapsed lease.
2 fields
rowslist of objectrequired- at most 50 items
4 fields
organizationIdstringrequired- not empty
statusstringrequired- one of
disabled,deleting
- one of
purgeAfterstringrequirednullablepurgeStartedAtstringrequirednullable
Other fields are allowed.
truncatedbooleanrequired
Other fields are allowed.
trialsEndingobjectrequiredTrials ending soon, soonest first.
2 fields
rowslist of objectrequired- at most 50 items
2 fields
organizationIdstringrequired- not empty
trialEndsAtstringrequired
Other fields are allowed.
truncatedbooleanrequired
Other fields are allowed.
purgesDueobjectrequiredDisabled organizations whose purge falls due soon.
2 fields
rowslist of objectrequired- at most 50 items
3 fields
organizationIdstringrequired- not empty
disabledAtstringrequirednullablepurgeAfterstringrequired
Other fields are allowed.
truncatedbooleanrequired
Other fields are allowed.
Other fields are allowed.
Other responses
| Status | Meaning | Body |
|---|---|---|
| 401 | Unauthorized |
|
| 403 | Forbidden |
|
| 500 | Internal Server Error |
|
| 503 | Service Unavailable |
|