Wambesha

La referencia de la API está disponible solo en inglés.

Account

GET/v1/account

Solo cuota de llamadas

Your plan, this period's usage against its allowances, a period-end projection and your spend controls. Never charged, even past your ceiling.

Parámetros

Este endpoint no admite parámetros.

Campos de la respuesta

planFREE | STARTER | PRO | STUDIO | ENTERPRISE
planPriceCentsinteger · int64
What THIS account pays per period, in integer cents - a negotiated Enterprise price if one is set, otherwise the published rate.
billingIntervalMONTHLY | ANNUAL
Annual is two months free.
billingStateACTIVE | PAST_DUE | FROZEN | SUSPENDED | CLOSED
FROZEN is a payment dispute; SUSPENDED is an operator action. Both refuse service and neither deletes anything.
periodStartstring · date-time
periodEndstring · date-time
allowancesobject · Allowances
The ceilings actually in force for this account: the tier default, cell by cell, with any per-account override applied. Resolved at ONE point (MeteringLimitsResolver) so an override cannot apply to some limits and silently miss others.
usageobject · Usage
Spend against the allowances, for the CURRENT billing period.
projectionobject · UsageProjection
Straight-line projection of this period spend to period end, from the fraction of the period elapsed. A projection, not a promise - it assumes the remaining days look like the ones so far.
overageEnabledboolean
Whether this account has opted IN to paying past its plan. The default is FALSE and the default is a hard stop: requests are refused with a 429 rather than billed. You are never charged for usage you did not explicitly opt in to.
spendCeilingCentsinteger · int64anulable
Your own stop-loss, in integer cents. ENFORCED, not decorative - overage stops here. null means no ceiling, reachable only with overage explicitly enabled.
overageMicrosPerVerificationinteger · int64anulable
What one verification past the plan costs, in micro-dollars. null means this plan has NO overage at all, which is different from a rate of zero.
withinGraceboolean
Whether the request that produced this response fell inside the 10% grace band above a monthly ceiling. Grace requests are served and are NOT billed. Mirrored on the X-Quota-Grace header.
featuresobject · PlanFeatures
What this plan entitles the account to. Every field is REPORTED from the same table that ENFORCES it, so a capability shown here is one the surface will actually allow.
healthobject · ConsoleHealth
"Is anything broken" - about YOUR integration, not about our platform. A global status page cannot tell a caller their own error rate has moved, which is the question this answers.

Encabezados de respuesta

X-Request-ID
The id of this request, on every response - success or error. Quote it to support: it is how we find your request in our logs. An X-Request-ID you send is honoured and echoed back, so you can use your own; otherwise we generate one. /v1 error bodies carry no trace id of their own.
X-Quota-Reset
RFC 3339 instant at which the billing period rolls. Present on every response to a request whose key was metered - every 2xx, every error a handler returned, and the quota 429. Absent on a refusal that happens before metering: a missing or unknown key (401), a restricted key or a plan that does not carry the endpoint (403), a public demo-key gate refusal, and the pre-authentication flood throttle.
X-Calls-Remaining
Requests left in the period after this one, never below 0. Present whenever X-Quota-Reset is (see there for when a response carries no quota headers).
X-Verifications-Remaining
How many verifications you can still make before a limit stops you. The daily limit and the monthly allowance are counted separately; this is whichever of the two runs out first. Sent whenever X-Quota-Reset is.
X-Quota-Grace
true when THIS request fell inside the 10% grace band above a monthly ceiling. A grace request is served and is not billed; treat true as "back off now", not as headroom. Always true or false, never absent when the other quota headers are present.
Retry-After429
Seconds to wait before retrying. On every 429 - the quota hard stop, the public demo key's limits, and the pre-authentication flood throttle (which carries this header alone, because no key has been read yet).
X-Demo-Challenge-ModeSolo con la clave de demostración
Sent only on responses to the public demo key. The value interactive asks the documentation page to show the visible verification widget - it is sent once a browser has made more than five runs in ten minutes or has received a 429. The page then repeats the header, X-Demo-Challenge-Mode: interactive, on its next request, with the widget's token in X-Demo-Challenge. Requests made with your own key never receive it.

Errores

Detalles

Everything about the account behind the key that made this call: plan, period, allowances, spend against them, the projection to period end, the overage setting and the spend ceiling.

Reading this does not consume quota. It is carved out of the hard stop deliberately - an account that has run out must still be able to see WHY, and charging a call to find out you have no calls left is the wrong answer.

Takes no account identifier: the key identifies the caller. The same answers are available from the session-authenticated console at /api/v1/developer/account, which exists because a customer with no key yet, or who has just revoked their only one, cannot reach this.

Pruébelo

Cargando la clave de demostración…

curl "https://api.wambesha.com/v1/account" \
  -H "Authorization: Bearer YOUR_API_KEY"

Ejemplo

{
  "plan": "PRO",
  "planPriceCents": 9900,
  "billingInterval": "MONTHLY",
  "billingState": "ACTIVE",
  "periodStart": "2026-09-27T00:00:00Z",
  "periodEnd": "2026-10-27T00:00:00Z",
  "allowances": {
    "requestsPerMonth": 5000000,
    "requestsPerDay": 500000,
    "verificationsPerMonth": 100000,
    "verificationsPerDay": 10000,
    "bandwidthBytesPerMonth": 6500000000000,
    "maxKeys": 20,
    "linkTtlSeconds": 43200
  },
  "usage": {
    "requests": 36,
    "verifications": 1,
    "requestsRemaining": 4999964,
    "verificationsRemaining": 99999
  },
  "projection": {
    "requestsAtPeriodEnd": 1800,
    "verificationsAtPeriodEnd": 50,
    "elapsedFraction": 0.02
  },
  "overageEnabled": false,
  "spendCeilingCents": null,
  "overageMicrosPerVerification": 1500,
  "withinGrace": false,
  "features": {
    "bulkExport": false,
    "perpetualRecordsLicence": false,
    "includeAllEligible": false,
    "attested": false,
    "supportResponseHours": 72,
    "slaPercent": null
  },
  "health": {
    "status": "failing",
    "errorRatePercent": 17.14,
    "requestsConsidered": 35,
    "notices": [
      "elevated_error_rate"
    ]
  }
}