# Autumn ## Docs - [Create Balance](https://docs.useautumn.com/api-reference/balances/createBalance.md): Create a balance for a customer feature. - [Delete Balance](https://docs.useautumn.com/api-reference/balances/deleteBalance.md): Delete a balance for a customer feature. Can only delete a balance that is not attached to a price (eg. you cannot delete messages that have an overage price). - [Finalize Lock](https://docs.useautumn.com/api-reference/balances/finalizeLock.md): Finalize a previously locked balance. Use 'confirm' to commit the deduction, or 'release' to return the held balance. - [Update Balance](https://docs.useautumn.com/api-reference/balances/updateBalance.md): Update a customer balance. - [Attach](https://docs.useautumn.com/api-reference/billing/attach.md): Attaches a plan to a customer. Handles new subscriptions, upgrades and downgrades. - [Update Subscription](https://docs.useautumn.com/api-reference/billing/billingUpdate.md): Updates an existing subscription. Use to modify feature quantities, cancel, or change plan configuration. - [Create Schedule](https://docs.useautumn.com/api-reference/billing/createSchedule.md): Creates a multi-phase subscription schedule for a customer. The first phase starts immediately and subsequent phases automatically transition at their scheduled start times. - [Multi Attach](https://docs.useautumn.com/api-reference/billing/multiAttach.md): Attaches multiple plans to a customer in a single request. Creates a single Stripe subscription with all plans consolidated. - [Open Customer Portal](https://docs.useautumn.com/api-reference/billing/openCustomerPortal.md): Create a billing portal session for a customer to manage their subscription. - [Preview Attach](https://docs.useautumn.com/api-reference/billing/previewAttach.md): Previews the billing changes that would occur when attaching a plan, without actually making any changes. - [Preview Multi Attach](https://docs.useautumn.com/api-reference/billing/previewMultiAttach.md): Previews the billing changes that would occur when attaching multiple plans, without actually making any changes. - [Preview Update](https://docs.useautumn.com/api-reference/billing/previewUpdate.md): Previews the billing changes that would occur when updating a subscription, without actually making any changes. - [Setup Payment](https://docs.useautumn.com/api-reference/billing/setupPayment.md): Create a payment setup session for a customer to add or update their payment method. - [Check Permissions](https://docs.useautumn.com/api-reference/core/check.md): Checks whether a customer currently has enough balance to use a feature. - [Track Usage](https://docs.useautumn.com/api-reference/core/track.md): Records usage for a customer feature and returns updated balances. - [Delete Customer](https://docs.useautumn.com/api-reference/customers/deleteCustomer.md): Deletes a customer by ID. - [Get Customer](https://docs.useautumn.com/api-reference/customers/getCustomer.md): Fetches a customer by ID, optionally expanding related data such as invoices or entities. - [Get or Create Customer](https://docs.useautumn.com/api-reference/customers/getOrCreateCustomer.md): Creates a customer if they do not exist, or returns the existing customer by your external customer ID. - [List Customers](https://docs.useautumn.com/api-reference/customers/listCustomers.md): Lists customers with pagination and optional filters. - [Update Customer](https://docs.useautumn.com/api-reference/customers/updateCustomer.md): Updates an existing customer by ID. - [Create Entity](https://docs.useautumn.com/api-reference/entities/createEntity.md): Creates an entity for a customer and feature, then returns the entity with balances and subscriptions. - [Delete Entity](https://docs.useautumn.com/api-reference/entities/deleteEntity.md): Deletes an entity by entity ID. - [Get Entity](https://docs.useautumn.com/api-reference/entities/getEntity.md): Fetches an entity by its ID. - [List Entities](https://docs.useautumn.com/api-reference/entities/listEntities.md): Lists entities across the organization with pagination and optional filters. - [Update Entity](https://docs.useautumn.com/api-reference/entities/updateEntity.md): Updates an existing entity and returns the refreshed entity object. - [Aggregate Events](https://docs.useautumn.com/api-reference/events/aggregateEvents.md): Aggregate usage events by time period. Returns usage totals grouped by feature and optionally by a custom property. - [List Events](https://docs.useautumn.com/api-reference/events/listEvents.md): List usage events for your organization. Filter by customer, feature, or time range. - [Create Feature](https://docs.useautumn.com/api-reference/features/createFeature.md): Creates a new feature. - [Delete Feature](https://docs.useautumn.com/api-reference/features/deleteFeature.md): Deletes a feature by its ID. - [Get Feature](https://docs.useautumn.com/api-reference/features/getFeature.md): Retrieves a single feature by its ID. - [List Features](https://docs.useautumn.com/api-reference/features/listFeatures.md): Lists all features in the current environment. - [Update Feature](https://docs.useautumn.com/api-reference/features/updateFeature.md): Updates an existing feature. - [Create a plan](https://docs.useautumn.com/api-reference/plans/createPlan.md): Creates a new plan with optional base price and feature configurations. - [Delete a plan](https://docs.useautumn.com/api-reference/plans/deletePlan.md): Deletes a plan by its ID. - [Get a plan](https://docs.useautumn.com/api-reference/plans/getPlan.md): Retrieves a single plan by its ID. - [List all plans](https://docs.useautumn.com/api-reference/plans/listPlans.md): Lists all plans in the current environment. - [Update a plan](https://docs.useautumn.com/api-reference/plans/updatePlan.md): Updates an existing plan. Creates a new version unless `disableVersion` is set. - [Create Organization](https://docs.useautumn.com/api-reference/platform/create-organization.md): Creates a new organization for a platform tenant. Reuses existing users and organizations if they already exist. - [List Organizations](https://docs.useautumn.com/api-reference/platform/list-orgs.md): Lists all organizations created by your master organization. Supports pagination. - [List Users](https://docs.useautumn.com/api-reference/platform/list-users.md): Lists all users created by your master organization. Supports pagination and optional expansion of related organizations. - [Generate Stripe OAuth URL](https://docs.useautumn.com/api-reference/platform/oauth-url.md): Generates a Stripe Connect OAuth URL for a platform organization. Use this to allow your tenants to connect their Stripe accounts. - [Overview](https://docs.useautumn.com/api-reference/platform/overview.md): Manage Autumn on behalf of your users in a multi-tenant flow - [Update Connected Stripe Account](https://docs.useautumn.com/api-reference/platform/update-stripe.md): Updates a platform organization's Stripe Connect configuration. Associates a Stripe account ID with the organization using your master Stripe credentials. - [Create Referral Code](https://docs.useautumn.com/api-reference/referrals/createReferralCode.md): Create or fetch a referral code for a customer in a referral program. - [Redeem Referral Code](https://docs.useautumn.com/api-reference/referrals/redeemReferralCode.md): Redeem a referral code for a customer. - [Limit Reached](https://docs.useautumn.com/api-reference/webhooks/balancesLimitReached.md): Fired when a customer reaches the limit for a feature (included allowance, max purchase, or spend limit). - [Usage Alert Triggered](https://docs.useautumn.com/api-reference/webhooks/balancesUsageAlertTriggered.md): Fired when a customer crosses a configured usage alert threshold. - [Auto Top-Up Succeeded](https://docs.useautumn.com/api-reference/webhooks/billingAutoTopupSucceeded.md): Fired when an automatic top-up grants additional prepaid balance. - [Resource Deleted](https://docs.useautumn.com/api-reference/webhooks/vercelResourcesDeleted.md): When a Vercel resource is deleted, you'll need to handle de-provisioning any API keys or other non-Autumn controlled data for this user. - [Resource Provisioned](https://docs.useautumn.com/api-reference/webhooks/vercelResourcesProvisioned.md): When a Vercel resource is created, you'll need to provision a secret key for your service. Then you can use the provided access token to patch the resource's secrets. - [Rotate Secrets](https://docs.useautumn.com/api-reference/webhooks/vercelResourcesRotateSecrets.md): This event is sent when Vercel requires a resource's secrets to be rotated. - [Webhook Event](https://docs.useautumn.com/api-reference/webhooks/vercelWebhooksEvent.md): Passthrough webhook for Vercel events. - [Changelog](https://docs.useautumn.com/changelog/changelog.md): Some new things we've shipped at Autumn HQ - [Command reference](https://docs.useautumn.com/cli/commands.md): Every command, flag, and option available in the atmn CLI - [Configuration reference](https://docs.useautumn.com/cli/config.md): Define features, plans, and pricing in autumn.config.ts - [Getting started](https://docs.useautumn.com/cli/getting-started.md): Install the CLI, authenticate, and sync your pricing config - [Balances](https://docs.useautumn.com/documentation/concepts/balances.md): Understanding how feature balances work in Autumn - [Features](https://docs.useautumn.com/documentation/concepts/features.md): Learn about features in Autumn and how to create them - [How It Works](https://docs.useautumn.com/documentation/concepts/overview.md): How features, plans, subscriptions and balances fit together - [Plan Items](https://docs.useautumn.com/documentation/concepts/plan-items.md): Configure what customers get access to when they purchase a plan - [Plans](https://docs.useautumn.com/documentation/concepts/plans.md): Learn about plans in Autumn and how to create them - [Stripe Sync](https://docs.useautumn.com/documentation/concepts/stripe.md): How Autumn creates and manages Stripe objects under the hood - [Subscriptions](https://docs.useautumn.com/documentation/concepts/subscriptions.md): How Autumn manages customer subscriptions - [Balance Locking](https://docs.useautumn.com/documentation/customers/balance-locking.md): Reserve balance upfront with locks, then confirm or release when the operation completes - [Billing Controls](https://docs.useautumn.com/documentation/customers/billing-controls.md): Configure overage behavior, spend limits, usage alerts, and auto top-ups per customer or entity - [Checking access](https://docs.useautumn.com/documentation/customers/check.md): Learn how to check feature access with the `check` endpoint - [Creating Customers](https://docs.useautumn.com/documentation/customers/creating-customers.md): Create customers via API or dashboard, link to Stripe, and pre-create for enterprise deals - [Custom Plans](https://docs.useautumn.com/documentation/customers/custom-plans.md): Create one-off plan variations for individual customers - [Billing Reliability](https://docs.useautumn.com/documentation/customers/edge-cases.md): How Autumn handles 3DS, payment failures, and other uncommon states - [Entities](https://docs.useautumn.com/documentation/customers/feature-entities.md): Learn how to use feature entities to track balances per separate entity, such as a user or a workspace - [Managing Balances](https://docs.useautumn.com/documentation/customers/managing-balances.md): Create, update, and manage balances via the dashboard or API - [Managing Customers](https://docs.useautumn.com/documentation/customers/managing-customers.md): Learn how to view and manage customer information in Autumn - [Payment Flow](https://docs.useautumn.com/documentation/customers/payment-flow.md): Hosted checkout pages vs building your own payment flow - [Subscription Lifecycle](https://docs.useautumn.com/documentation/customers/subscription-lifecycle.md): Handle upgrades, downgrades, and cancellations - [Tracking usage](https://docs.useautumn.com/documentation/customers/tracking-usage.md): Keep track of your customer's feature usage with the `track` route - [Updating Subscriptions](https://docs.useautumn.com/documentation/customers/updating-subscriptions.md): Modify existing subscriptions - update quantities, cancel, or customize - [Versioning Plans](https://docs.useautumn.com/documentation/customers/versioning.md): How to update and migrate customers between product versions - [Convex](https://docs.useautumn.com/documentation/external-providers/convex.md): Implementing the Autumn + Convex component - [RevenueCat](https://docs.useautumn.com/documentation/external-providers/revenuecat.md): Integrate Autumn with RevenueCat for mobile app billing - [Vercel Marketplace](https://docs.useautumn.com/documentation/external-providers/vercel-marketplace.md): Set up the Vercel Marketplace integration in Autumn - [Fail-Open Defaults](https://docs.useautumn.com/documentation/fail-open.md): Keep your app running even when Autumn is unreachable - [Deploy to production](https://docs.useautumn.com/documentation/getting-started/deploy.md): A checklist to go live with confidence - [Build your billing page](https://docs.useautumn.com/documentation/getting-started/display-billing.md): Display usage and billing data in your app for your users - [Checking and tracking](https://docs.useautumn.com/documentation/getting-started/gating.md): Give customers access to the right features and limits based on their plan - [Migrating to Autumn](https://docs.useautumn.com/documentation/getting-started/migration.md): How to migrate your existing Stripe customers to Autumn - [Setup and payments](https://docs.useautumn.com/documentation/getting-started/setup.md): Implement your app's payments and pricing model - [Add-Ons](https://docs.useautumn.com/documentation/modelling-pricing/add-ons.md): Offer additional plans and features customers can purchase alongside their plan - [Auto Top-Ups](https://docs.useautumn.com/documentation/modelling-pricing/auto-top-ups.md): Automatically replenish customer balances when they run low - [Credit Systems](https://docs.useautumn.com/documentation/modelling-pricing/credit-systems.md): Learn how to create a credit system in Autumn - [Free Plans](https://docs.useautumn.com/documentation/modelling-pricing/free-plans.md): Offer free tiers with usage limits to onboard customers - [Graduated Pricing](https://docs.useautumn.com/documentation/modelling-pricing/graduated-pricing.md): Set tiered pricing where different usage ranges are charged at different rates - [One-Off Purchases](https://docs.useautumn.com/documentation/modelling-pricing/one-off-purchases.md): Configure one-time purchases and lifetime plans - [Per-Unit Pricing](https://docs.useautumn.com/documentation/modelling-pricing/per-unit-pricing.md): Charge customers based on the number of units they use, such as seats or workspaces - [Prepaid Pricing](https://docs.useautumn.com/documentation/modelling-pricing/prepaid-pricing.md): Charge customers upfront for a quantity of a feature, and draw from it as usage occurs - [Proration](https://docs.useautumn.com/documentation/modelling-pricing/proration.md): Handle mid-cycle plan changes with prorated billing - [Recurring Plans](https://docs.useautumn.com/documentation/modelling-pricing/recurring.md): Grant customers a recurring allowance of consumable features like messages, credits, or API calls - [Rewards and Referrals](https://docs.useautumn.com/documentation/modelling-pricing/rewards.md): Learn how to use rewards and referrals to incentivize your customers. - [Rollovers](https://docs.useautumn.com/documentation/modelling-pricing/rollovers.md): Allow unused balances to carry over to the next billing period - [Spend Limits & Usage Alerts](https://docs.useautumn.com/documentation/modelling-pricing/spend-limits.md): Cap overage spending and get notified when usage crosses thresholds - [Sub-Entity Balances](https://docs.useautumn.com/documentation/modelling-pricing/sub-entity-balances.md): Grant individual usage limits to entities like users or workspaces under a customer - [Sub-Entity Plans](https://docs.useautumn.com/documentation/modelling-pricing/sub-entity-plans.md): Assign separate plans to entities under a parent customer - [Trials](https://docs.useautumn.com/documentation/modelling-pricing/trials.md): Let customers try paid plans before committing - [Usage-Based Pricing](https://docs.useautumn.com/documentation/modelling-pricing/usage-based-pricing.md): Bill customers based on actual usage at the end of each billing period - [Volume-Based Tiers](https://docs.useautumn.com/documentation/modelling-pricing/volume-based-tiers.md): Charge a single rate based on the total volume of usage - [Rate Limits](https://docs.useautumn.com/documentation/rate-limits.md): Default API rate limits and how to request increases - [Slack and Discord Notifications](https://docs.useautumn.com/documentation/slack-discord-notifications.md): Send Autumn webhook events to Slack or Discord channels with rich, formatted messages using Svix transformations. - [Webhooks](https://docs.useautumn.com/documentation/webhooks.md): Receive real-time notifications when customer billing events occur - [Entity-level balances](https://docs.useautumn.com/examples/entity-balances.md): Grant usage limits per entity, such as 50 credits per user per month - [Monetary credits](https://docs.useautumn.com/examples/monetary-credits.md): Grant your users a currency-based balance of credits, that various features can draw from - [Pay-as-you-go overages](https://docs.useautumn.com/examples/pay-as-you-go-overages.md): Let free plan users optionally add a card to pay for usage overages instead of getting blocked - [Per-seat pricing](https://docs.useautumn.com/examples/per-seat.md): Implement per-seat pricing with free included seats and paid additional seats - [One-time top ups](https://docs.useautumn.com/examples/prepaid.md): Let customers purchase a prepaid package to top up their balance when it falls low. - [Trial - card not required](https://docs.useautumn.com/examples/trial-card-not-required.md): Enable a trial period that customers can access without providing payment information - [Trial - card required](https://docs.useautumn.com/examples/trial-card-required.md): Enable a trial period where customers must provide payment information upfront. - [autumnHandler](https://docs.useautumn.com/react/hooks/autumn-handler.md): Server-side handler for managing Autumn API endpoints and customer authentication - [](https://docs.useautumn.com/react/hooks/autumn-provider.md): Provider component for your React application - [Introduction](https://docs.useautumn.com/react/hooks/introduction.md): How Autumn's React hooks work - [useAggregateEvents](https://docs.useautumn.com/react/hooks/useAggregateEvents.md): Show event usage to your customers in a timeseries chart - [useCustomer](https://docs.useautumn.com/react/hooks/useCustomer.md): Access a customer's state and billing actions in your React app - [useEntity](https://docs.useautumn.com/react/hooks/useEntity.md): Access an entity's state in your React app - [useListEvents](https://docs.useautumn.com/react/hooks/useListEvents.md): List and paginate through individual customer events - [useListPlans](https://docs.useautumn.com/react/hooks/useListPlans.md): Fetch the list of available plans - [useReferrals](https://docs.useautumn.com/react/hooks/useReferrals.md): Create and redeem referral codes - [Welcome to Autumn](https://docs.useautumn.com/welcome.md): Drop-in, open-source control layer for AI and SaaS monetization. ## OpenAPI Specs - [openapi](https://docs.useautumn.com/api/openapi.yml) - [openapi-local](https://docs.useautumn.com/api/openapi-local.yml) - [openapi-2.0.0](https://docs.useautumn.com/api/openapi-2.0.0.yml) - [openapi-1.2.0](https://docs.useautumn.com/api/openapi-1.2.0.yml) - [platform](https://docs.useautumn.com/api-reference/platform.yaml) ## Optional - [Discord](https://discord.gg/STqxY92zuS) - [GitHub](https://github.com/useautumn/autumn) - [Website](https://useautumn.com)