Skip to navigation

Get Billing

Your current plan and billing state: the effective included volume and daily cap, any overage ceiling, the current period’s boundaries, and whether a plan change or a cancellation is already scheduled for the next period. Read-only.

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.
billing_statusstring

active, past_due, or suspended — only an active account can send.

included_deliveriesinteger

Deliveries included this period. After a mid-period plan change this is prorated by the time spent on each plan — see allowance_proration.

plan_included_deliveriesinteger
Deliveries the current plan includes in a full period, before any proration.
daily_capinteger
Deliveries the account may send in one UTC day.
object"billing"OptionalDefaults to billing

Always billing.

allowance_prorationobject or nullOptional

Breakdown of included_deliveries per plan; null when the whole period ran on one plan.

overall_overage_cap_usddouble or nullOptional

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

current_period_startdatetime or nullOptional

Start of the current billing period; null before the first period opens.

current_period_enddatetime or nullOptional

End of the current billing period; null before the first period opens.

cancel_at_period_endbooleanOptionalDefaults to false

true when the subscription is set to end at current_period_end.

pending_planstring or nullOptional

Plan that takes effect at the start of the next period; null when no change is scheduled.

outstanding_invoiceobject or nullOptional

Open overage invoice freezing the account; null when nothing is owed.

Errors

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