Usage

curl --request GET \
  --url https://api.eventory.ai/usage \
  --header 'apikey: <api-key>'

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://api.eventory.ai/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "customer_id": "cus_abc123",
  "plan": "basic",
  "plan_ids": {
    "subscription_id": "sub_123",
    "price_id": "price_123",
    "product_id": "prod_123"
  },
  "status": "active",
  "usage_status": "ok",
  "cancel_at_period_end": false,
  "canceled_at": null,
  "trial_end": null,
  "unit": "credits",
  "as_of": "2026-06-12T09:15:00Z",
  "period": {
    "start": "2026-06-01T00:00:00Z",
    "end": "2026-07-01T00:00:00Z",
    "days_remaining": 19,
    "elapsed_fraction": 0.3771
  },
  "credits": {
    "included": 5000,
    "used": 1234,
    "remaining": 3766,
    "overage": 0,
    "percent_used": 24.68,
    "projected_used": 3272,
    "hard_cap": 6000,
    "in_overage": false
  }
}

Account

Credit usage and plan

Returns your plan, billing period, and credit usage, fetched live from billing on every call. credits.used can trail your most recent requests by a minute or so. Any valid key may call this endpoint, whatever routes it is granted, so it is also the safest way to test a key.

credits.included is the quota bundled into your plan; crossing it bills overage rather than blocking. credits.hard_cap is where the gateway stops serving with 402 limit_reached. usage_status is a single field to switch on.

Cost: free.

GET

usage

Usage

curl --request GET \
  --url https://api.eventory.ai/usage \
  --header 'apikey: <api-key>'

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://api.eventory.ai/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "customer_id": "cus_abc123",
  "plan": "basic",
  "plan_ids": {
    "subscription_id": "sub_123",
    "price_id": "price_123",
    "product_id": "prod_123"
  },
  "status": "active",
  "usage_status": "ok",
  "cancel_at_period_end": false,
  "canceled_at": null,
  "trial_end": null,
  "unit": "credits",
  "as_of": "2026-06-12T09:15:00Z",
  "period": {
    "start": "2026-06-01T00:00:00Z",
    "end": "2026-07-01T00:00:00Z",
    "days_remaining": 19,
    "elapsed_fraction": 0.3771
  },
  "credits": {
    "included": 5000,
    "used": 1234,
    "remaining": 3766,
    "overage": 0,
    "percent_used": 24.68,
    "projected_used": 3272,
    "hard_cap": 6000,
    "in_overage": false
  }
}

Authorizations

apikey

string

header

required

Your Eventory API key. Sent as the apikey request header.

Response

Usage report.

customer_id

string

plan

string | null

Plan name. null without an active subscription.

plan_ids

object | null

Show child attributes

status

string

Subscription status. Only active and trialing are served by the gateway; none means no subscription.

Example:

"active"

usage_status

enum<string>

approaching_limit from 80% of included; over_included once overage starts; at_hard_cap when the gateway is refusing requests.

Available options:

ok,

approaching_limit,

over_included,

at_hard_cap,

none

cancel_at_period_end

boolean

canceled_at

string<date-time> | null

trial_end

string<date-time> | null

unit

string | null

Billing unit label

as_of

string<date-time>

period

object | null

Show child attributes

credits

object

Show child attributes

Overview

Market Data

Live Availability

Watchlist

Account

Credit usage and plan

Authorizations

Response