autumn-concepts

Explains Autumn billing concepts including plans, features, balances, trials, and billing controls.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Billing state in Autumn often does not match a plain reading of a plan: trials change when billing starts, entity-scoped subscriptions differ from customer-level ones, and caps, overage, and top-ups interact in non-obvious ways. This Skill provides the mental model and reference definitions needed to reason correctly about Autumn billing before writing config or calling the API.

Core Features & Use Cases

  • Object graph mental model: Maps organizations, features, plans, plan items, customers, entities, subscriptions, purchases, balances, and flags, and how attach turns plan configuration into runtime customer state.
  • Definition references: Loads focused references for features, plans, plan items, customize diffs, trials, customer vs entity scoping, and billing controls when reasoning about a specific object.
  • Edge-case guidance: Clarifies when included usage is already a hard cap, how overage and spend limits actually behave, how trial end modes affect Stripe billing anchors, and how entity-level state overrides customer-level state.
  • Use Case: A customer's usage stopped at zero even though no spend limit was set. Load this Skill to learn that included is the cap when no overage price or overage_allowed control exists, avoiding a useless spend_limit change.

Quick Start

Ask the assistant to explain why a customer's balance stopped at zero on their current Autumn plan and what change would allow paid overage.

Frequently Asked Questions about autumn-concepts

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

FAQPage Schema
How do I model usage-based overage pricing in Autumn?

Add a usage-based price to the plan item for that feature, which lets the balance go below zero and bills the overage. Alternatively set the `overage_allowed` billing control; without either, the included amount is already a hard cap.

What is the difference between a customer and an entity in Autumn?

A customer is the primary billed subject, while entities are optional child subjects like seats or sub-accounts. Entity-level check and track calls can use customer-level state, but customer-level calls do not inherit entity-level subscriptions or balances.

How do free trials work with existing Stripe subscriptions in Autumn?

Attach the new plan with `on_end: "revert"` to grant trial access without touching the Stripe subscription, reverting to the original plan at trial end. Choosing to bill on end resets the Stripe billing anchor, which may be undesired.

When should I use spend limits versus usage limits in Autumn?

Spend limits cap overage only, in feature units, and do nothing when no overage is permitted. Usage limits gate total usage per time window independently of the balance and apply whether or not overage exists.

How do I remove a feature from a plan using customize?

Use `remove_items` with the feature_id, adding billing_method or interval filters if multiple items match. Never set `included: 0` in `add_items`, since that grants the feature with zero allowance instead of withholding it.