# Autumn

## Docs

- [Attach](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/attach.md): Attaches a plan to a customer. Handles new subscriptions, upgrades and downgrades.
- [Update Subscription](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/billingUpdate.md): Updates an existing subscription. Use to modify feature quantities, cancel, or change plan configuration.
- [Preview Attach](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/previewAttach.md): Previews the billing changes that would occur when attaching a plan, without actually making any changes.
- [Preview Update](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/previewUpdate.md): Previews the billing changes that would occur when updating a subscription, without actually making any changes.
- [Setup Payment](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/setupPayment.md): Create a payment setup session for a customer to add or update their payment method.
- [Preview Multi Attach](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/previewMultiAttach.md): Previews the billing changes that would occur when attaching multiple plans, without actually making any changes.
- [Multi Attach](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/multiAttach.md): Attaches multiple plans to a customer in a single request. Creates a single Stripe subscription with all plans consolidated.
- [Preview Multi Update](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/previewMultiUpdate.md): Previews the billing changes of a multi-plan update without making any changes. Returns one core preview per affected subscription.
- [Create Schedule](https://autumn-b9b4c0fb-dev.mintlify.site/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.
- [Import](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/billing/import.md): Image a customer into Autumn for live migration. Read-only against processors.
- [Check Permissions](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/core/check.md): Checks whether a customer currently has enough balance to use a feature.
- [Track Usage](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/core/track.md): Records usage for a customer feature and returns updated balances.
- [Get or Create Customer](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/customers/getOrCreateCustomer.md): Creates a customer if they do not exist, or returns the existing customer by your external customer ID.
- [Get Customer](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/customers/getCustomer.md): Fetches a customer by ID, optionally expanding related data such as invoices or entities.
- [List Customers](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/customers/listCustomers.md): Lists customers with cursor pagination and optional filters. Pass `start_cursor: ""` (or omit) for the first page; use `next_cursor` from a prior response for subsequent pages.
- [Update Customer](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/customers/updateCustomer.md): Updates an existing customer by ID.
- [Get Entity](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/entities/getEntity.md): Fetches an entity by its ID.
- [List Entities](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/entities/listEntities.md): Lists entities across the organization with pagination and optional filters.
- [Create Entity](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/entities/createEntity.md): Creates an entity for a customer and feature, then returns the entity with balances and subscriptions.
- [Update Entity](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/entities/updateEntity.md): Updates an existing entity and returns the refreshed entity object.
- [Get a plan](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/plans/getPlan.md): Retrieves a single plan by its ID.
- [List all plans](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/plans/listPlans.md): Lists all plans in the current environment.
- [Create a plan](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/plans/createPlan.md): Creates a new plan with optional base price and feature configurations.
- [Update a plan](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/plans/updatePlan.md): Updates an existing plan. Creates a new version unless `disableVersion` is set.
- [Get Feature](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/features/getFeature.md): Retrieves a single feature by its ID.
- [List Features](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/features/listFeatures.md): Lists all features in the current environment.
- [Create Feature](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/features/createFeature.md): Creates a new feature.
- [Update Feature](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/features/updateFeature.md): Updates an existing feature.
- [Create Referral Program](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/referrals/createReferralProgram.md): Create a referral program linked to an existing reward.
- [Update Referral Program](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/referrals/updateReferralProgram.md): Update a referral program. Omitted fields keep their current value.
- [Create Reward](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/rewards/createReward.md): Create a coupon or feature grant.
- [Plans Updated](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/webhooks/billingUpdated.md): Fired when a customer's plans change — activated, scheduled, updated, or expired. Each event carries a `plan_changes` array describing what happened and a `tags` array (e.g. `trial_ended`, `phase_changed`) describing why.

## OpenAPI Specs

- [openapi](https://autumn-b9b4c0fb-dev.mintlify.site/api/openapi.yml)
- [openapi-local](https://autumn-b9b4c0fb-dev.mintlify.site/api/openapi-local.yml)
- [openapi-2.0.0](https://autumn-b9b4c0fb-dev.mintlify.site/api/openapi-2.0.0.yml)
- [openapi-1.2.0](https://autumn-b9b4c0fb-dev.mintlify.site/api/openapi-1.2.0.yml)
- [platform](https://autumn-b9b4c0fb-dev.mintlify.site/api-reference/platform.yaml)

## Optional

- [Discord](https://discord.gg/STqxY92zuS)
- [GitHub](https://github.com/useautumn/autumn)
- [Website](https://useautumn.com)