GET /v1/alerts/allowance
The allowance meter: how many alerts were sent to the account one by one in the current UTC day and month, against the plan’s limits (`limit: null` is unlimited), with the instant each period ends. `over` is true when either limit is reached; `upgrade` is true when some plan has a higher limit. Resolutions and alerts delivered in a summary are not counted. The same object is embedded in GET /v1/alerts/settings. Session only. 404 `alert_settings_disabled` while ALERT_SETTINGS_ENABLED is off.
The allowance meter: how many alerts were sent to the account one by one in the current UTC day and month, against the plan’s limits (limit: null is unlimited), with the instant each period ends. over is true when either limit is reached; upgrade is true when some plan has a higher limit. Resolutions and alerts delivered in a summary are not counted. The same object is embedded in GET /v1/alerts/settings. Session only. 404 alert_settings_disabled while ALERT_SETTINGS_ENABLED is off.
API key: Authorization: Bearer pk_live_… (mint at polyrank.app/api-keys)
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/alerts/allowance"{ "plan": "string", "day": { "used": -9007199254740991, "limit": -9007199254740991, "resets_at": "string" }, "month": { "used": -9007199254740991, "limit": -9007199254740991, "resets_at": "string" }, "over": true, "upgrade": true}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}{ "error": "string", "message": "string", "feature": "string", "field": "string", "plan": "string", "retry_after_sec": 0, "retry_after_seconds": 0, "reason": "string", "issues": [ null ], "trace_id": "string"}