Skip to navigation
API Referencebilling

Get Usage

What you have sent this billing period: the deliveries included in your plan, the deliveries used, anything beyond the included volume and what it costs so far, the daily cap and today’s use against it, and a live per-workspace volume breakdown.

These are the same live counters the send path enforces against, so the number here is the number that stops a send. A workspace key sees only its own workspace in workspaces.

Authentication

AuthorizationBearer

A workspace key (rray_live_…, bound to one workspace) or the account’s platform key. Platform keys name the target workspace with RRay-Workspace-Id. See Credentials.

Response

Successful Response
planstring
The account's current plan.
included_deliveriesinteger

Deliveries included this period. After a mid-period plan change it is prorated by the time spent on each plan; GET /v1/billing breaks the proration down.

used_deliveriesinteger
Deliveries sent so far this period, across every workspace.
overage_deliveriesinteger

Deliveries sent beyond included_deliveries this period.

overage_usddouble

Cost in USD of overage_deliveries so far this period.

daily_capinteger
Deliveries the account may send in one UTC day.
daily_usedinteger
Deliveries sent so far in the current UTC day.
period_startdatetime

Start of the current billing period (RFC 3339, UTC).

period_enddatetime

End of the current billing period (RFC 3339, UTC).

object"usage"OptionalDefaults to usage

Always usage.

overall_overage_cap_usddouble or nullOptional

Ceiling in USD on total overage this period; null when no cap is set.

workspaceslist of objectsOptionalDefaults to []

Per-workspace delivery volume this period. A workspace key sees only its own workspace here.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error