Struct UsageSnapshot 

pub struct UsageSnapshot {
    pub source: UsageSourceKind,
    pub fetched_at: SystemTime,
    pub five_hour: Option<UsageWindow>,
    pub seven_day: Option<UsageWindow>,
    pub seven_day_opus: Option<UsageWindow>,
    pub seven_day_sonnet: Option<UsageWindow>,
    pub extra_usage: Option<ExtraUsage>,
    pub spend: Option<ApiSpend>,
    pub balance: Option<f64>,
}

Snapshot of the user’s Anthropic plan utilization at a point in time. Composed by the forge-gateway backends and rendered by a view.

Fields

source: UsageSourceKind

fetched_at: SystemTime

five_hour: Option<UsageWindow>

seven_day: Option<UsageWindow>

seven_day_opus: Option<UsageWindow>

seven_day_sonnet: Option<UsageWindow>

extra_usage: Option<ExtraUsage>

spend: Option<ApiSpend>

Per-key spend for an API-billed account. None for every window-billed source, and for every row written before this field existed - serde decodes a missing key on an Option to None, which is what keeps the cached rows readable.

balance: Option<f64>

The OpenRouter account’s remaining credit pool, in USD: total_credits - total_usage from /v1/credits. Account-wide - every key on the account draws on the same pool - unlike the per-key figures in ApiSpend. None when the credits fetch failed, when the 200 carried no data envelope, and for every cached row written before this field existed, decoded as absent like spend above.

Implementations

impl UsageSnapshot

pub fn five_hour_util(&self) -> Option<f64>

None when the snapshot carries no five-hour window, which is a documented steady state on the lenient mapper rather than a zero.

pub fn seven_day_util(&self) -> Option<f64>

Binding 7-day utilisation: max across the three 7-day windows (seven_day, seven_day_opus, seven_day_sonnet). Whichever is most-used is the binding constraint for “is this account 7-day rate-limited.”

None when all three are absent, which a 200 carrying only the session window produces.

pub fn binding_reset_at(&self) -> Option<SystemTime>

When a rate-limited account unlocks: the latest resets_at among windows currently at-or-over the cap (per is_currently_limited). None when no window is currently capped, so a reset ETA is shown only on rate-limited rows.

pub fn same_usage(&self, other: &UsageSnapshot) -> bool

Whether two snapshots say the same thing, fetched_at aside.

Derived PartialEq cannot answer this: fetched_at moves on every probe, so two successful polls that found an unchanged pool compare unequal and every poll reads as news. The field says when a reading was taken, not what it says, and it is the only one excluded here - a new usage field belongs in the comparison below.

Trait Implementations

impl Clone for UsageSnapshot

fn clone(&self) -> UsageSnapshot

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UsageSnapshot

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UsageSnapshot

fn deserialize<__D>( __deserializer: __D, ) -> Result<UsageSnapshot, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UsageSnapshot

fn eq(&self, other: &UsageSnapshot) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for UsageSnapshot

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UsageSnapshot