Skip to main content
You can manage customer balances through the Autumn dashboard or programmatically via the API.

From the Dashboard

Viewing Balances

  1. Go to the Customers page
  2. Click on a customer to view their details
  3. Their balances are displayed in the Balances section, including breakdown by source

Modifying a Balance

To set or add to a feature’s balance:
  1. Navigate to the customer’s detail page
  2. Under the balances section, click on the feature you want to modify. If there are stacked balances, choose the one you want to modify.
  3. Choose whether to set the balance to a specific value or add to the balance
  4. Enter the amount and save

Creating Standalone Balances (API)

You can use the /balances/create endpoint to grant balances independent of any plan, for example to issue one-time promotional credits, referral rewards, or make manual customer adjustments. You can also set expiration dates for promotional usage grants and configure reset intervals.
import { Autumn } from "autumn-js";

const autumn = new Autumn({ secretKey: "am_sk_..." });

await autumn.balances.create({
  customer_id: "user_123",
  feature_id: "credits",
  granted_balance: 500,
  reset: {
    interval: "one_off"
  }
});
See the Create Balance API reference for all available parameters.

Updating Balances (API)

Use the /customers/{customer_id}/balances endpoint to set balances for a customer.
import { Autumn } from "autumn-js";

const autumn = new Autumn({ secretKey: "am_sk_..." });

await autumn.customers.updateBalances("user_123", {
  balances: [{ feature_id: "credits", balance: 750 }]
});
See the Set Feature Balance API reference for all available parameters.

Querying Balances

Via Get Customer

Retrieve all balances for a customer:
const customer = await autumn.customers.get("user_123");
console.log(customer.balances);
See the Get Customer API reference for the full response schema.

Via Check Endpoint

Check access and get the current balance for a specific feature:
const result = await autumn.check({
  customer_id: "user_123",
  feature_id: "credits"
});

console.log(result.allowed);
console.log(result.balance);
See the Check API reference for more details.