63 actions

Action

Description

Check Entitlement

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

Track Usage

Records usage for a customer feature and returns updated balances.

Batch Track Usage

Enqueue up to 1000 usage events for asynchronous processing.

Track Token Usage

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

Create Balance

Create a balance for a customer feature.

Update Balance

Update a customer balance.

Delete Balance

Delete a balance for a customer feature.

Finalize Lock

Finalize a previously locked balance.

Attach Plan

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

Update Subscription

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

Preview Attach

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

Preview Update

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

Open Customer Portal

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

Setup Payment

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

Preview Multi Attach

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

Multi Attach

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

Preview Multi Update

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

Multi Update

Updates multiple plans on a customer in a single request. Currently supports cancel actions (immediately, end of cycle,...

Create Schedule

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

Import Billing

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

Get Or Create Customer

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

Get Customer

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

List Customers

Lists customers with cursor pagination and optional filters.

Update Customer

Updates an existing customer by ID.

Delete Customer

Deletes a customer by ID.

Get Entity

Fetches an entity by its ID.

List Entities

Lists entities across the organization with pagination and optional filters.

Create Entity

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

Update Entity

Updates an existing entity and returns the refreshed entity object.

Delete Entity

Deletes an entity by entity ID.

List Events

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

Aggregate Events

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

Get Feature

Retrieves a single feature by its ID.

List Features

Lists all features in the current environment.

Create Feature

Creates a new feature.

Update Feature

Updates an existing feature.

Delete Feature

Deletes a feature by its ID.

Insert Invoices

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

List Invoices

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

Mint Key

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

Revoke Key

Revokes every outstanding token for a customer.

Attach License

Assigns licenses to one or more entities.

Release License

Releases licenses assigned to one or more entities.

List Licenses

Lists a customer's license pools and available seats.

List License Assignments

Lists license assignments for a customer.

Get Plan

Retrieves a single plan by its ID.

List Plans

Lists all plans in the current environment.

Create Plan

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

Update Plan

Updates an existing plan.

Delete Plan

Deletes a plan by its ID.

Create Referral Program

Create a referral program linked to an existing reward.

List Referral Programs

List the referral programs configured for the org.

Get Referral Program

Fetch a referral program by ID.

Update Referral Program

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

Delete Referral Program

Delete a referral program.

Create Referral Code

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

Redeem Referral Code

Redeem a referral code for a customer.

Create Reward

Create a coupon or feature grant.

List Rewards

List the coupons and feature grants configured for the org.

Get Reward

Fetch a coupon or feature grant by ID.

Update Reward

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

Delete Reward

Delete a coupon or feature grant.

Redeem Reward Code

Redeem a reward promo code for a customer.