balances

Explains how Autumn balances, caps, overage, and billing controls govern feature usage.

2.7k|244|Updated Jan 21, 2025
One-click install
npx skills add https://github.com/useautumn/autumn --skill balances
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: balances
Source: https://github.com/useautumn/autumn/tree/main/packages/agent-docs/generated/skills/balances
Command: npx skills add https://github.com/useautumn/autumn --skill balances

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Billing logic around usage limits is confusing: developers often add redundant spend limits, misunderstand when usage can pass zero, or misconfigure overage behavior. This Skill clarifies exactly how Autumn balances behave at zero and what each billing control actually does, preventing misconfigured caps and unexpected charges.

Core Features & Use Cases

  • Cap and Overage Semantics: Explains that an included allowance is already a hard cap unless a usage-based price or the overage_allowed control permits usage past zero.
  • Billing Control Reference: Details overage_allowed, spend_limits, usage_limits, usage_alerts, and auto_topups, including scope (customer vs entity) and interaction rules.
  • Track Behavior Guidance: Covers overage_behavior options (cap vs overflow) when tracking usage deductions that exceed the remaining balance.
  • Use Case: A developer wants to cap a feature at its included amount. This Skill tells them no spend_limit is needed because the balance already stops at zero, avoiding redundant configuration.

Quick Start

Ask how to enforce a hard usage cap on a feature in Autumn and whether a spend limit is needed.

Frequently Asked Questions about balances

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I cap feature usage at the included amount in Autumn?

The included allowance is already a hard cap: usage stops at zero and check returns allowed: false. You only need to avoid setting a usage-based price or the overage_allowed control; no spend_limit is required.

What allows usage to go past a zero balance in Autumn?

Only two things permit usage past zero: a usage-based price on the plan item, which bills for overage, or the overage_allowed billing control. Nothing else overrides the zero cap.

What is the difference between spend limits and usage limits in Autumn?

Spend limits cap overage in feature units (not dollars) and only apply when overage is permitted. Usage limits are independent hard caps on total usage over a time window, applying whether or not overage exists.

Do usage alerts block usage in Autumn?

No, usage alerts only notify when usage crosses a threshold and never block usage. Blocking requires usage limits, spend limits, or simply not enabling overage.

Can entity-level billing controls override customer-level controls?

Yes, entity-level controls can override customer-level controls for that specific entity. The exception is auto top-ups, which are customer-level only.

What does overage_behavior do when tracking usage in Autumn?

On track, overage_behavior controls deductions that exceed the balance: cap (default) deducts only what fits and stops at zero, while overflow deducts the full value and lets the balance go negative.