Get Usage | AgentPhone

import { AgentPhoneClient } from "agentphone";
async function main() {
    const client = new AgentPhoneClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.usage.getUsage();
}
main();

{
  "plan": {
    "name": "string",
    "limits": {
      "numbers": 1,
      "messagesPerMonth": 1,
      "voiceMinutesPerMonth": 1,
      "maxCallDurationMinutes": 1,
      "concurrentCalls": 1
    }
  },
  "numbers": {
    "used": 1,
    "limit": 1,
    "remaining": 1
  },
  "stats": {
    "totalMessages": 1,
    "messagesLast24h": 1,
    "messagesLast7d": 1,
    "messagesLast30d": 1,
    "totalCalls": 1,
    "callsLast24h": 1,
    "callsLast7d": 1,
    "callsLast30d": 1,
    "totalWebhookDeliveries": 1,
    "successfulWebhookDeliveries": 1,
    "failedWebhookDeliveries": 1
  },
  "periodStart": "string",
  "periodEnd": "string"
}

Get usage statistics for the current project.

Returns:

Phone number limits (used/limit/remaining)
Message statistics (total, last 24h, last 7 days, last 30 days)
Call statistics (total, last 24h, last 7 days, last 30 days)
Webhook delivery statistics

Get usage statistics for the current project. Returns: - Phone number limits (used/limit/remaining) - Message statistics (total, last 24h, last 7 days, last 30 days) - Call statistics (total, last 24h, last 7 days, last 30 days) - Webhook delivery statistics

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response

planobject

numbersobject

statsobject

periodStartstring

periodEndstring