Get daily billing usage history

GET/api/v2/billing/usage/history

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Query parameters

daysinteger

Number of calendar days to include, capped at 90.

min 1 · max 90 · default: 30

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Responses

200

Daily usage history and totals returned.

successbooleanrequired

Allowed:true

dataobjectrequired

Show properties

periodobjectrequired

Show properties

daysintegerrequired

startDatestring<date>required

endDatestring<date>required

historyBillingUsageDay[]required

Show properties

Array of BillingUsageDay

datestring<date>required

messagesPublishedintegerrequired

min 0

messagesDeliveredintegerrequired

min 0

messagesFailedintegerrequired

min 0

schedulesExecutedintegerrequired

min 0

totalsBillingUsageTotalsrequired

Show properties

messagesPublishedintegerrequired

min 0

messagesDeliveredintegerrequired

min 0

messagesFailedintegerrequired

min 0

schedulesExecutedintegerrequired

min 0

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - Rate limit exceeded

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.daysqueryNumber of calendar days to include, capped at 90.

Request

curl -X GET 'https://api.anlyon.com/api/v2/billing/usage/history' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.anlyon.com/api/v2/billing/usage/history", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.anlyon.com/api/v2/billing/usage/history",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "period": {
      "days": 0,
      "startDate": "2019-08-24",
      "endDate": "2019-08-24"
    },
    "history": [
      {
        "date": "2019-08-24",
        "messagesPublished": 0,
        "messagesDelivered": 0,
        "messagesFailed": 0,
        "schedulesExecuted": 0
      }
    ],
    "totals": {
      "messagesPublished": 0,
      "messagesDelivered": 0,
      "messagesFailed": 0,
      "schedulesExecuted": 0
    }
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}