SecureAgentMail

Balance and usage summary

Returns the current credit balance, usage totals, and a per-category breakdown for the current billing period.

GET
/credits

Authorization

BearerAuth
AuthorizationBearer <token>

API key passed as a Bearer token. Production keys start with am_live_ and sandbox keys start with am_test_.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://secureagentmail.com/api/v1/credits"
{
  "plan": "growth",
  "credits_used": 4200,
  "credits_limit": 10000,
  "credits_remaining": 5800,
  "billing_period_start": "2026-02-01T00:00:00Z",
  "billing_period_end": "2026-02-28T23:59:59Z",
  "breakdown": {
    "messages_received": {
      "count": 120,
      "credits": 1200
    },
    "messages_sent": {
      "count": 120,
      "credits": 1200
    },
    "ai_scans": {
      "count": 120,
      "credits": 1200
    },
    "pii_redactions": {
      "count": 120,
      "credits": 1200
    },
    "hitl_reviews": {
      "count": 120,
      "credits": 1200
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key.",
    "status": 401
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Please retry after 30 seconds.",
    "status": 429
  }
}