API reference

Get billing and usage summary

GET/v1/billing/summary

Authorization

Send a personal API key or an OAuth access token as Authorization: Bearer <token>.

OAuth scopes: billing:read

Responses

200Success

planobjectrequired
namestringrequired
status"active" | "trialing" | "past_due" | "canceled" | "incomplete" | "unpaid" | "none"required
isTrialbooleanrequired
interval"monthly" | "annual" | nullrequired
priceCentsinteger | nullrequired
unlimitedbooleanrequired
renewsAtstring (date-time) | nullrequired
cancelAtPeriodEndbooleanrequired
usageobjectrequired
includedobject | nullrequired
period"daily" | "weekly" | "monthly"required
remainingPercentnumberrequired
resetsAtstring (date-time) | nullrequired
topUpFundsDollarsnumberrequired

400Invalid request

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

401Missing or invalid Bearer credential

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

402Payment or subscription required

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

403Credential is missing a required scope

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

404Resource not found

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

409Request conflict

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

429Rate limit exceeded

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

500Internal API error

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

curl --request GET \
  --url 'https://api.staging.adam.new/v1/billing/summary' \
  --header 'Authorization: Bearer <token>'

{
  "plan": {
    "name": "<string>",
    "status": "active",
    "isTrial": true,
    "interval": "monthly",
    "priceCents": 0,
    "unlimited": true,
    "renewsAt": "2026-01-01T00:00:00.000Z",
    "cancelAtPeriodEnd": true
  },
  "usage": {
    "included": {
      "period": "daily",
      "remainingPercent": 0,
      "resetsAt": "2026-01-01T00:00:00.000Z"
    },
    "topUpFundsDollars": 0
  }
}