API referenceUsage & Limits

Check whether an amount of a resource fits the plan

posthttps://api.expiryedge.com/v1/checkResourceLimit
any role60/minAny method
Request
curl -X POST 'https://api.expiryedge.com/v1/checkResourceLimit' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resourceType": "expiries",
  "amount": 1
}'
Response
{
  "success": true,
  "data": {
    "allowed": true,
    "current": 312,
    "limit": 1000,
    "remaining": 688
  }
}

Returns allowed: false (still 200) when current + amount would exceed the limit or the subscription is not active. If the check itself fails it returns allowed: true with reason: Error checking limits. Token failures return 500 with details.

Body parameters

application/json
  • resourceTypestringrequired
    A limit key, for example expiries, contacts, storage, users, workflows, workflow_runs, ai_scans, teams, categories, collection_templates, collection_requests, email_templates, custom_field_templates.
  • amountinteger
    How many will be added (bytes for storage).
    Default 1

Returns

200
Limit check.
  • successboolean
  • dataobject

Errors

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
The request failed (including an invalid or missing token).