Developer portal

PATCH /admin/tenants/{tenant_id}

Update tenant subscription tier (free, monitor, convert, enterprise).

PATCH /admin/tenants/{tenant_id}Auth: admin

Summary

Update tenant subscription tier (free, monitor, convert, enterprise).

Response

{
  "status": "success",
  "tenantId": "acme-bank",
  "tier": "convert"
}

Field	Type	Required	Description
tier	"free" \| "monitor" \| "convert" \| "enterprise"	Yes	New subscription tier. e.g. convert

Field

Type

Required

Description

tier

"free" | "monitor" | "convert" | "enterprise"

Yes

New subscription tier.

e.g. convert

Code	Meaning	Typical cause	Suggested fix
404	Not found	Scan, schedule, share link, or resource id does not exist or expired.	Verify id and tenant scope; share links expire per expiresHours.
422	Unprocessable entity	Invalid payload shape, unsupported scenario, or infeasible constraints.	Fix field errors in response detail; relax constraints and retry.
429	Too many requests	Per-key rate limit exceeded (default 300 requests per minute) or public endpoint limit.	Backoff with jitter; cache results; request higher limit for production.
500	Internal server error	Unexpected backend failure; includes requestId in response.	Retry with exponential backoff; contact support with requestId if persistent.