GET /v1/usage

Daftar Isi
  1. Ringkasan
  2. Contoh Request
  3. Contoh Response
  4. Field Response
  5. Memantau Sisa Kuota Tanpa Panggilan Ekstra

Referensi Endpoint

Ringkasan

GET /v1/usage menampilkan pemakaian kuota harian Anda saat ini: paket aktif, batas harian, jumlah terpakai, sisa, dan waktu reset. Endpoint ini tidak mengurangi kuota kalkulasi tarif Anda — pakai untuk dashboard internal atau health-check sebelum menjalankan batch besar.

Base URL: https://api.agenwebsite.com/v1 · Autentikasi lewat header x-api-key.

Kuota bersifat harian & per-user. Batas dihitung per hari dan di-reset setiap 00:00 WIB (Asia/Jakarta, UTC+7). Semua API key milik user yang sama berbagi satu kuota.

Contoh Request

Request · cURL

curl https://api.agenwebsite.com/v1/usage \
  -H "x-api-key: awk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Contoh Response

Response · 200 OK

{
  "success": true,
  "data": {
    "plan": "pro",
    "limit": 30000,
    "used": 1450,
    "remaining": 28550,
    "reset_at": "2026-07-03T00:00:00+07:00"
  }
}

Field Response

Field Tipe Keterangan
plan string Paket aktif: free, pro, atau max.
limit integer Batas request per hari (Free 150 · Pro 30.000 · Max 60.000).
used integer Jumlah request yang sudah dipakai pada window hari ini.
remaining integer Sisa kuota = limit - used.
reset_at string (ISO 8601) Waktu window kuota berikutnya dibuka — 00:00 WIB keesokan hari.

Memantau Sisa Kuota Tanpa Panggilan Ekstra

Setiap response dari endpoint ber-autentikasi (termasuk /v1/rates) sudah menyertakan header rate-limit. Baca header ini agar tidak perlu memanggil /v1/usage secara terpisah:

Response Headers

X-RateLimit-Limit: 30000
X-RateLimit-Remaining: 28550
X-RateLimit-Reset: 2026-07-03T00:00:00+07:00
Header Keterangan
X-RateLimit-Limit Batas harian sesuai paket.
X-RateLimit-Remaining Sisa kuota setelah request ini.
X-RateLimit-Reset Waktu reset window (00:00 WIB).
Retry-After Hanya pada 429 — detik hingga boleh mencoba lagi.
Pola aman: pantau X-RateLimit-Remaining. Saat mendekati nol, jeda pengiriman hingga X-RateLimit-Reset. Bila kuota habis, API mengembalikan 429 rate_limit_exceeded disertai header Retry-After — hormati nilainya sebelum mengulang. Butuh kuota lebih besar? Upgrade ke Pro (30.000/hari) atau Max (60.000/hari).