Documentation / Subscriber

Subscriber

Endpoints for the Subscriber resource. All calls require authentication and return the standard JSON envelope.

🔗

Base URL: https://companybelgium.be/api/v2 · Authentication

Authenticated customer snapshot#

GET/me

Returns the current plan, monthly quota and live usage for the authenticated API key. Does not count against your quota.

This endpoint takes no parameters.

Request

curl https://companybelgium.be/api/v2/me \
  -H "X-API-Key: $API_KEY" -H "X-API-Secret: $API_SECRET"
const res = await fetch("https://companybelgium.be/api/v2/me", {
  method: "GET",
  headers: {
    "X-API-Key": process.env.API_KEY,
    "X-API-Secret": process.env.API_SECRET,
  },
});
const { data } = await res.json();

Response

{
  "success": true,
  "data": {
    "plan": "pro",
    "quota": {
      "limit": 50000,
      "used": 1234,
      "resetAt": "2026-07-01T00:00:00Z"
    },
    "rateLimit": {
      "perHour": 5000
    }
  },
  "error": null,
  "timestamp": "2026-06-05T09:00:00.000Z",
  "meta": null
}