---
name: bijection-autumn
description: "Evaluate and integrate the Autumn component with Bijection."
---

# Autumn

A autumn component for Bijection.

- Package: @bijectionhq/autumn
- Category: Payments
- Status: Preview
- License: Apache-2.0
- Bijection source (repository access required): https://github.com/bijectionhq/autumn/tree/ae774427c30b0dd7425a0e070286146e236d4194/convex
- Upstream: https://github.com/useautumn/typescript/tree/ecadaf19293f558bea04565a19d4aff3abaebc8c/convex
- Documentation: https://docs.bijection.com/components/using
- Directory: https://bijection.com/components/autumn

## Get the source

Bijection repository access is required. Request access at https://bijection.com/contact.

```sh
git clone https://github.com/bijectionhq/autumn.git
cd autumn
git checkout ae774427c30b0dd7425a0e070286146e236d4194
cd convex
```

## Before using this component

Read the package README at the recorded revision for setup, dependencies, and API examples. Upstream documentation describes the original package and may differ from the Bijection adaptation. This is a source candidate for evaluation. Catalog inclusion does not establish npm availability or runtime qualification. Check compatibility with your SDK and deployment before adoption. External providers run their own compute.

## Integration workflow

1. Read the source README and package manifest at the recorded revision.
2. Confirm the required SDK, dependency availability, and runtime compatibility.
3. Follow the component's documented setup and configuration. Never invent an npm install command from a catalog package name.
4. Keep credentials in the project's existing secret store.
5. Follow the project's execution rules for verification and report what was actually checked.

## Original upstream skill

The following guidance describes @useautumn/convex. Its installation commands and APIs refer to the upstream package. Evaluate compatibility with the Bijection source separately.


# Autumn

## Instructions

Autumn provides a complete pricing and billing system built on top of Stripe, designed specifically for Convex applications. It abstracts complex billing logic into three core functions: check for feature access, track for usage metering, and checkout for purchases. The component handles subscriptions, usage-based pricing, seat-based billing, trials, and credits while providing both backend APIs and React components for frontend integration.

### Installation

```bash
npm install @useautumn/convex
```

## Use cases

- **Usage-based billing**: Track API calls, messages, or compute usage with `autumn.track()` and automatically bill customers based on consumption
- **Feature gating**: Use `autumn.check()` to restrict access to premium features like advanced analytics or higher rate limits based on subscription tiers
- **Self-serve upgrades**: Drop in the `<PricingTable/>` component or use `checkout()` with custom UI to let users upgrade their plans without leaving your app
- **Multi-tenant billing**: Leverage the `identify()` function to bill at the organization level while tracking individual user actions within teams
- **Freemium conversions**: Combine usage tracking with access checks to automatically prompt upgrades when users hit plan limits

## How it works

The component integrates with your Convex app through a standard component configuration in `convex.config.ts` and requires setting up an Autumn client with your Stripe credentials. The core architecture centers around an `identify()` function that maps your authentication system to Autumn's customer model, supporting various auth providers like Convex Auth, Clerk, or custom solutions.

On the backend, you use three primary functions: `autumn.check()` validates feature access before executing actions, `autumn.track()` records usage for metering, and `autumn.checkout()` initiates purchase flows. These functions integrate directly with your Convex mutations and actions, allowing you to gate features and track usage inline with your business logic.

The frontend integration uses an `<AutumnProvider/>` wrapper that connects to your Convex client, enabling React hooks like `useCustomer()` for accessing billing data and triggering upgrades. Pre-built components like `<PricingTable/>` and `<CheckoutDialog/>` provide ready-to-use UI, while the hooks allow for custom billing interfaces that fit your app's design.

## When NOT to use

- When a simpler built-in solution exists for your specific use case
- If you are not using Convex as your backend
- When the functionality provided by Autumn is not needed

## Resources

- [npm package](https://www.npmjs.com/package/%40useautumn%2Fconvex)
- [GitHub repository](https://github.com/useautumn/autumn-js/blob/main/convex/README.md)
- [Live demo](https://docs.useautumn.com/documentation/getting-started/setup/convex)
- [Convex Components Directory](https://www.convex.dev/components/autumn)
- [Convex documentation](https://docs.convex.dev)