Autumn SDK

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

Use this to gate access before a feature action. Enable sendEvent when you want to check and consume balance atomically in one request.

• track - Records usage for a customer feature. Queued by default; pass async: false to apply it before responding with updated balances.

Use this after an action happens to decrement usage, or send a negative value to credit balance back.

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

Use this after an LLM request when you have input and output token counts. Autumn converts token usage to a dollar amount using the configured model pricing and markup, then tracks that value against the customer's AI credit system.

• batch_track - Enqueue up to 1000 usage events for asynchronous processing. Items are validated synchronously up front; validated items are then enqueued via SQS for background deduction by workers. The response returns 200 (or 202) immediately and does not include balance information. On partial enqueue failure (some items fail to enqueue, others succeed), the endpoint still returns 200 (or 202) and logs the failures server-side; clients should NOT retry, because retrying re-enqueues the already-succeeded items. A 503 is returned only when zero items were successfully enqueued (queue entirely unavailable) — that case is safe to retry.

Balances

• create - Create a balance for a customer feature.
• list - Lists individual balances (one row per grant) across customers, live or expired: plan balances, standalone balances, top-ups, and pooled balances. Pages may hold fewer than limit rows while has_more is true.
• update - Update a customer balance.
• delete - 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 - Finalize a previously locked balance. Use 'confirm' to commit the deduction, or 'release' to return the held balance.

Billing

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

Use this endpoint to subscribe a customer to a plan, upgrade/downgrade between plans, or add an add-on product.

• create_schedule - Creates a multi-phase subscription schedule for a customer. The first phase starts immediately and subsequent phases automatically transition at their scheduled start times.

Use this endpoint to schedule future plan changes (e.g. switch from a trial plan to a paid plan on a specific date) or to define a sequence of plans that should activate over time.

• multi_attach - Attaches multiple plans to a customer in a single request. Creates a single Stripe subscription with all plans consolidated.

Use this endpoint when you need to subscribe a customer to multiple plans at once, such as a base plan plus add-ons, or to create a bundle of products.

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

Use this endpoint to show customers what they will be charged before confirming a subscription change.

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

Use this endpoint to show customers what they will be charged before confirming a multi-plan subscription.

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

Use this endpoint to update prepaid quantities, cancel a subscription (immediately or at end of cycle), or modify subscription settings.

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

Use this endpoint to show customers prorated charges or refunds before confirming subscription modifications.

• multi_update - Updates multiple plans on a customer in a single request. Currently supports cancel actions (immediately, end of cycle, or uncancel) across one or more subscriptions.

Use this endpoint to cancel or uncancel several plans atomically in one call — for example canceling a main plan together with its add-ons, or plans across multiple entities.

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

Use this endpoint to show customers the credits and next-cycle changes of canceling multiple plans before confirming.

• 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.
• verify - Checks a customer's Stripe subscriptions against Autumn's record of their plans and reports any drift. Read-only: it never changes Autumn or Stripe.

Use this endpoint to audit that a customer's Stripe subscriptions, items, quantities, prices, schedules and cancellation state match what Autumn expects, for example after a migration or a manual change in Stripe.

• import_ - Import

Customers

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

Use this as the primary entrypoint before billing operations so the customer record is always present and up to date.

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

Use this when you know the customer exists or assert they exist without creating them.

• list - 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 - Updates an existing customer by ID.
• delete - Deletes a customer by ID.
• advance_test_clock - Advance a customer's Stripe test clock to a future time in milliseconds. Only Stripe test-mode customers with a test clock are supported. Advancement is asynchronous; Stripe enforces clock status and advancement limits.
• list_subscriptions - Lists recurring plans (including add-ons) across customers, live or expired. Filter by customer, entity, plan, or status. Pages may hold fewer than limit rows while has_more is true.
• list_purchases - Lists one-off plan purchases across customers, live or expired. Filter by customer, entity, plan, or status. Pages may hold fewer than limit rows while has_more is true.

Entities

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

Use entities when usage and access must be scoped to sub-resources (for example seats, projects, or workspaces) instead of only the customer.

• get - Fetches an entity by its ID.

Use this to read one entity's current state. Pass customerId when you want to scope the lookup to a specific customer.

• list - Lists entities across the organization with pagination and optional filters.

Use this to page through entities globally, including filtering by plans inherited from parent customers or attached directly to entities.

• update - Updates an existing entity and returns the refreshed entity object.

Use this to change entity billing controls or other mutable entity fields after the entity has already been created.

• delete - Deletes an entity by entity ID.

Use this when the underlying resource is removed and you no longer want entity-scoped balances or subscriptions tracked for it.

Events

• list - List usage events for your organization. Filter by customer, feature, or time range.
• aggregate - Aggregate usage events by time period. Returns usage totals grouped by feature and optionally by a custom property.

Features

• create - Creates a new feature.

Use this to programmatically create features for metering usage, managing access, or building credit systems.

• get - Retrieves a single feature by its ID.

Use this when you need to fetch the details of a specific feature.

• list - Lists all features in the current environment.

Use this to retrieve all features configured for your organization to display in dashboards or for feature management.

• update - Updates an existing feature.

Use this to modify feature properties like name, display settings, or to archive a feature.

• delete - Deletes a feature by its ID.

Use this to permanently remove a feature. Note: features that are used in products cannot be deleted - archive them instead.

Invoices

• create - Creates a standalone send-invoice Stripe invoice from catalog pricing and custom charges. Quantities are billable units, exclusive of any included usage; Autumn applies billing units and tiers. Nothing about the customer's plans, balances or subscriptions changes. Pass preview: true to get the calculated lines and totals without creating an invoice.
• finalize - Finalizes a draft Stripe invoice, such as one left in draft by invoice mode with finalize set to false. Stripe then collects it: a send-invoice invoice is emailed and an automatically-charged one is charged. Any plan still waiting on the invoice to be paid expires at its due date. Already open or paid invoices are returned unchanged.
• insert - Inserts or updates up to 500 historical invoices without reading or mutating the billing processor.
• list - Lists invoices with cursor pagination and optional filters (customer, entity, status, processor). Pass start_cursor: "" (or omit) for the first page; use next_cursor from a prior response for subsequent pages.
• list_templates - Lists the organization's invoice templates, newest first, with offset pagination. Use a template's id as invoice_template_id when creating or reissuing an invoice.
• pay - Marks an open Stripe invoice as paid out of band. No charge is attempted; use this when payment was collected elsewhere (e.g. a marketplace). Already-paid invoices are returned unchanged.
• issue_credit_note - Issues a Stripe credit note against an open or paid invoice, for a flat amount or for specific invoice lines. On an open invoice the credit reduces what is still owed. On a paid invoice the credited money goes to the chosen destination: the customer's balance (default), a refund, or a record of money returned outside Stripe. Line amounts are pre-discount and pre-tax, like the invoice's own item amounts. Pass preview to see the credit note without issuing it.
• reissue - Voids an open send-invoice Stripe invoice and issues a replacement with the same line items. An invoice template can supply the replacement's footer (e.g. bank details) and memo. The replacement keeps the original due date unless net_terms_days is passed, which is required once the original is past due. Pass update_customer_email to change the customer's billing email first so the replacement is sent there. The replacement stays linked to the same subscription and fulfils the same pending plan when paid.
• update - Changes which payment methods a draft or open Stripe invoice accepts. The customer sees the change on the hosted invoice page straight away.
• void - Voids an open or uncollectible Stripe invoice. Any plan still waiting on the invoice to be paid expires. Voiding an unpaid subscription invoice lets Stripe re-derive the subscription status from its remaining invoices, which can move a past-due subscription back to active. Already-void invoices are returned unchanged.

Keys

• mint - Mints a per-customer token (a scoped am_jwt_ credential) so a downstream / self-hosted app can call Autumn directly without your secret key. Returns a short-lived access token plus a rotating refresh token, both bound to the given customer. Authenticated with your secret key.
• refresh - Exchanges a refresh token (sent as the Bearer credential) for a freshly rotated access + refresh pair. Self-service for the token holder — no secret key required. The previous refresh token is honored for one rotation as a grace window; replaying an older one revokes the customer's tokens.
• revoke - Revokes every outstanding token (access and refresh) for a customer. Authenticated with your secret key. New tokens can be issued afterwards with keys.mint.

Licenses

• attach - Assigns licenses to one or more entities.
• release - Releases licenses assigned to one or more entities.

Logs

• search - Search API requests and incoming Stripe webhooks for your organization and environment.

Plans

• create - Create a plan
• get - Get a plan
• list - List all plans
• update - Update a plan
• delete - Delete a plan

Platform

• get_stripe_connection - Read a managed organization's Stripe OAuth connection, account ID, and authorization time in the selected environment.
• disconnect_stripe - Revoke Autumn's Stripe OAuth access for a managed organization in the selected environment. Does not delete the Stripe account or cancel subscriptions.
• link_revenue_cat - Generate a RevenueCat OAuth URL for linking a project to an organization.
• sync_revenue_cat - Push an organization's plans into RevenueCat as products (creating or renaming them across the project's apps) and set test-store prices from each plan's price. Requires the org to have linked RevenueCat via OAuth.
• get_revenue_cat_keys - Retrieve a managed organization's RevenueCat public (SDK) API keys, grouped by app — for the test store, App Store, and Google Play Store. Use these to configure the RevenueCat SDK in the org's mobile app.

Referrals

• create_code - Create or fetch a referral code for a customer in a referral program.
• redeem_code - Redeem a referral code for a customer.
• create_program - Create a referral program linked to an existing reward.
• list_programs - List the referral programs configured for the org.
• get_program - Fetch a referral program by ID.
• update_program - Update a referral program. Omitted fields keep their current value.
• delete_program - Delete a referral program.

Rewards

• create - Create a coupon or feature grant.
• list - List the coupons and feature grants configured for the org.
• get - Fetch a coupon or feature grant by ID.
• update - Update a coupon or feature grant. Omitted fields keep their current value.
• delete - Delete a coupon or feature grant.
• redeem_code - Redeem a reward promo code for a customer.

Sandboxes

• create - Creates a sandbox: an isolated copy of your organization with its own catalog, customers and secret key. Returns the sandbox's secret key once, in this response — store it, it cannot be read back. Authenticated with your organization's secret key (a sandbox's own key cannot create sandboxes).
• list - Lists every sandbox belonging to your organization, newest first. Secret keys are never returned here — only sandboxes.create shows one.
• delete - Permanently deletes a sandbox and everything inside it: its catalog, customers and secret key. Cannot be undone.
• reset - Wipes every customer, plan, feature and migration draft in the sandbox the calling key belongs to, leaving the sandbox itself, its secret keys and its settings in place. There is no id to pass: a sandbox's own key resets that sandbox, and an organization's test-mode key resets its default sandbox environment. Refused for live keys — only sandboxes can be reset. Cannot be undone.

Webhooks

• create - Creates a webhook: a URL Autumn sends the listed events to, in the environment of the calling key. You choose the id, and it can't be changed later. Returns the signing secret once, in this response — store it, it cannot be read back.
• get - Gets one webhook by ID. The signing secret is never returned here — only webhooks.create and webhooks.sync show one, when they create the webhook.
• list - Lists every webhook in the environment of the calling key, including ones made in the dashboard (these show their ep_… ID).
• update - Updates a webhook's URL, events, description or disabled state. Only the fields you pass change. The ID can't be changed — to rename, create a new webhook.
• delete - Permanently deletes a webhook. Autumn stops sending it events immediately. Cannot be undone.
• preview_sync - Shows what webhooks.sync would do with the same body, without changing anything: which webhooks it would create, update or delete, and which existing ones it would leave alone because the body doesn't list them.
• sync - Makes the listed webhooks exist as described: creates missing ones and updates ones that differ. Webhooks not listed are left alone, unless skip_deletions is false: then every webhook not listed is deleted, including ones made in the dashboard. Returns the signing secret of each webhook it created, once. Each webhook is applied on its own: failures are listed in errors while the rest still apply, and the request fails only when none could be applied.

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from AutumnError:

• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.