> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Autumn

> How to set up the Autumn connector, plus the actions and events that are available.

![Autumn](https://stackone-logos.com/api/autumn/filled/svg)

v1.0.0[See changelog](https://docs.stackone.com/connectors/autumn/changelog.md)

[62 actions](#actions) · [5 events](#events) · 1 auth method

Billing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/autumn/guides/connector-profile/api-key.md)
>
> Uses a server-side secret key (am\_sk\_) sent as a bearer token. Use an am\_sk\_test\_ key to target the sandbox. No OAuth or...

Optionally, configure receiving Events for Autumn into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/autumn/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/autumn/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

62 actions

ActionDescription

Check Entitlement`autumn_check_entitlement`

Checks whether a customer currently has enough balance to use a feature.

Track Usage`autumn_track_usage`

Records usage for a customer feature and returns updated balances.

Batch Track Usage`autumn_batch_track_usage`

Enqueue up to 1000 usage events for asynchronous processing.

Track Token Usage`autumn_track_token_usage`

Records AI token usage for a customer and returns the updated AI credit balance.

Create Balance`autumn_create_balance`

Create a balance for a customer feature.

Update Balance`autumn_update_balance`

Update a customer balance.

Delete Balance`autumn_delete_balance`

Delete a balance for a customer feature.

Finalize Lock`autumn_finalize_lock`

Finalize a previously locked balance.

Attach Plan`autumn_attach_plan`

Attaches a plan to a customer. Handles new subscriptions, upgrades and downgrades.

Update Subscription`autumn_update_subscription`

Updates an existing subscription. Use to modify feature quantities, cancel, or change plan configuration.

Preview Attach`autumn_preview_attach`

Previews the billing changes that would occur when attaching a plan, without actually making any changes.

Preview Update`autumn_preview_update`

Previews the billing changes that would occur when updating a subscription, without actually making any changes.

Open Customer Portal`autumn_open_customer_portal`

Create a billing portal session for a customer to manage their subscription.

Setup Payment`autumn_setup_payment`

Create a payment setup session for a customer to add or update their payment method.

Preview Multi Attach`autumn_preview_multi_attach`

Previews the billing changes that would occur when attaching multiple plans, without actually making any changes.

Multi Attach`autumn_multi_attach`

Attaches multiple plans to a customer in a single request. Creates a single Stripe subscription with all plans consolida...

Preview Multi Update`autumn_preview_multi_update`

Previews the billing changes of a multi-plan update without making any changes. Returns one core preview per affected su...

Create Schedule`autumn_create_schedule`

Creates a multi-phase subscription schedule for a customer. The first phase starts immediately and subsequent phases aut...

Import Billing`autumn_import_billing`

Image a customer into Autumn for live migration. Read-only against processors.

Get Or Create Customer`autumn_get_or_create_customer`

Creates a customer if they do not exist, or returns the existing customer by your external customer ID.

Get Customer`autumn_get_customer`

Fetches a customer by ID, optionally expanding related data such as invoices or entities.

List Customers`autumn_list_customers`

Lists customers with cursor pagination and optional filters.

Update Customer`autumn_update_customer`

Updates an existing customer by ID.

Delete Customer`autumn_delete_customer`

Deletes a customer by ID.

Get Entity`autumn_get_entity`

Fetches an entity by its ID.

List Entities`autumn_list_entities`

Lists entities across the organization with pagination and optional filters.

Create Entity`autumn_create_entity`

Creates an entity for a customer and feature, then returns the entity with balances and subscriptions.

Update Entity`autumn_update_entity`

Updates an existing entity and returns the refreshed entity object.

Delete Entity`autumn_delete_entity`

Deletes an entity by entity ID.

List Events`autumn_list_events`

List usage events for your organization. Filter by customer, feature, or time range.

Aggregate Events`autumn_aggregate_events`

Aggregate usage events by time period. Returns usage totals grouped by feature and optionally by a custom property.

Get Feature`autumn_get_feature`

Retrieves a single feature by its ID.

List Features`autumn_list_features`

Lists all features in the current environment.

Create Feature`autumn_create_feature`

Creates a new feature.

Update Feature`autumn_update_feature`

Updates an existing feature.

Delete Feature`autumn_delete_feature`

Deletes a feature by its ID.

Insert Invoices`autumn_insert_invoices`

Inserts or updates up to 500 historical invoices without reading or mutating the billing processor.

List Invoices`autumn_list_invoices`

Lists invoices with cursor pagination and optional filters (customer, entity, status, processor).

Mint Key`autumn_mint_key`

Mints a per-customer token so a downstream or self-hosted app can call Autumn directly without your secret key.

Revoke Key`autumn_revoke_key`

Revokes every outstanding token for a customer.

Attach License`autumn_attach_license`

Assigns licenses to one or more entities.

Release License`autumn_release_license`

Releases licenses assigned to one or more entities.

List Licenses`autumn_list_licenses`

Lists a customer's license pools and available seats.

List License Assignments`autumn_list_license_assignments`

Lists license assignments for a customer.

Get Plan`autumn_get_plan`

Retrieves a single plan by its ID.

List Plans`autumn_list_plans`

Lists all plans in the current environment.

Create Plan`autumn_create_plan`

Creates a new plan with optional base price and feature configurations.

Update Plan`autumn_update_plan`

Updates an existing plan.

Delete Plan`autumn_delete_plan`

Deletes a plan by its ID.

Create Referral Program`autumn_create_referral_program`

Create a referral program linked to an existing reward.

List Referral Programs`autumn_list_referral_programs`

List the referral programs configured for the org.

Get Referral Program`autumn_get_referral_program`

Fetch a referral program by ID.

Update Referral Program`autumn_update_referral_program`

Update a referral program. Omitted fields keep their current value.

Delete Referral Program`autumn_delete_referral_program`

Delete a referral program.

Create Referral Code`autumn_create_referral_code`

Create or fetch a referral code for a customer in a referral program.

Redeem Referral Code`autumn_redeem_referral_code`

Redeem a referral code for a customer.

Create Reward`autumn_create_reward`

Create a coupon or feature grant.

List Rewards`autumn_list_rewards`

List the coupons and feature grants configured for the org.

Get Reward`autumn_get_reward`

Fetch a coupon or feature grant by ID.

Update Reward`autumn_update_reward`

Update a coupon or feature grant. Omitted fields keep their current value.

Delete Reward`autumn_delete_reward`

Delete a coupon or feature grant.

Redeem Reward Code`autumn_redeem_reward_code`

Redeem a reward promo code for a customer.

## Events

Tags

Select all
|
Clear

Balances

Subscriptions

Webhooks

No tags found

5 events

EventDescriptionTags

Usage Alert Triggered Webhook`autumn_webhook_usage_alert_triggered`

Fired when a customer crosses a configured usage alert threshold for a feature.

BalancesWebhooks

Limit Reached Webhook`autumn_webhook_limit_reached`

Fired when a customer reaches the limit for a feature (included allowance, max purchase, spend limit, or usage-limit con...

BalancesWebhooks

Auto Top-Up Failed Webhook`autumn_webhook_auto_topup_failed`

Fired when an automatic top-up is blocked, declined, or fails before granting additional prepaid balance.

SubscriptionsWebhooks

Auto Top-Up Succeeded Webhook`autumn_webhook_auto_topup_succeeded`

Fired when an automatic top-up grants additional prepaid balance to a customer.

SubscriptionsWebhooks

Plans Updated Webhook`autumn_webhook_billing_updated`

Fired when a customer's plans change (activated, scheduled, updated, or expired), carrying a plan\_changes array and tags...

SubscriptionsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.