مرجع API

مصرف و وضعیت پلن

GEThttps://data.zevix.ir/v1/usage

پلن، پایان اشتراک، سقف‌ها و مصرف امروز همین کلید.

برای نمایش وضعیت در پنل خودتان یا هشدار پیش از تمام شدن سهمیه. این درخواست هم یک درخواست حساب می‌شود.

پارامترها

پارامتر	محل	نوع	توضیح
`X-API-Key`الزامی	header	string	کلید API شما

فیلدهای پاسخ

فیلد	نوع	توضیح
`data.plan`	string	نام پلن
`data.ends_at`	string	پایان اشتراک
`data.rate_per_minute`	integer	سقف درخواست در دقیقه
`data.daily_quota`	integer	سهمیه روزانه (صفر یعنی نامحدود)
`data.used_today`	integer	مصرف امروز این کلید (به وقت تهران)
`data.history_days`	integer	حداکثر بازه تاریخچه
`data.stream / widget`	boolean	دسترسی به ارسال زنده و ویجت
`data.key`	string	پیشوند کلید

پاسخ‌های خطا

HTTP	کد	چه وقت
401	`api_key_required`	هیچ‌کدام از `X-API-Key`، `Authorization: Bearer` یا `api_key` در درخواست نیست.	راه‌حل ←
401	`invalid_api_key`	کلید اشتباه تایپ شده، باطل شده یا وجود ندارد.	راه‌حل ←
402	`subscription_expired`	پلن فعالی برای حساب نیست (تمام شده یا هنوز نخریده‌اید).	راه‌حل ←
429	`rate_limited`	بیش از سقف پلن در یک دقیقه درخواست داده‌اید.	راه‌حل ←

همه کدها و راه‌حل‌ها: کدهای وضعیت و خطا.

درخواست

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://data.zevix.ir/v1/usage"

پاسخ 200

{
  "data": {
    "plan": "حرفه‌ای",
    "ends_at": "2026-11-01T09:12:00+03:30",
    "rate_per_minute": 120,
    "daily_quota": 200000,
    "used_today": 1843,
    "history_days": 365,
    "stream": true,
    "widget": true,
    "key": "zxp_a1B2c3"
  }
}