Charchy Senddocs

Get usage

Where your workspace stands: this term's plan emails, your credits and their expiry, today's cap, the rate limit, and today's test sends. Needs a key with full permission.

GET
/usage

Where your workspace stands: this term's plan emails, your credits and their expiry, today's cap, the rate limit, and today's test sends. Needs a key with full permission.

apiKey
headerAuthorizationBearer <token>

Authorization: Bearer chy_live_… (or chy_test_…). A live key may be sending-only, and may be locked to one domain.

Response Body

Your usage right now.

application/json
  1. response
plan*|

The current monthly plan, or null without one.

credits*|

Pay-as-you-go credits, or null with none.

daily*
rate_limit*
test*
Example Request
import { CharchySend } from "@charchy/send"const send = new CharchySend() // reads CHARCHY_SEND_KEYconst { data, error } = await send.usage.get()
Example Response
{  "plan": {    "key": "growth",    "emails_included": 50000,    "emails_used": 12840,    "emails_left": 37160,    "term_ends_at": "2026-12-14T09:00:00Z"  },  "credits": {    "emails": 25000,    "expires_at": "2027-02-10T00:00:00Z"  },  "daily": {    "cap": 5000,    "surge_cap": 10000,    "used": 612,    "resets_at": "2026-11-17T00:00:00Z"  },  "rate_limit": {    "requests_per_second": 10,    "burst": 20  },  "test": {    "daily_cap": 1000,    "used": 37  }}