Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.balances.delete({
customerId: "cus_123",
featureId: "api_calls",
});{
"success": true
}Balances
Delete Balance
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).
POST
/
v1
/
balances.delete
Typescript (SDK)
import { Autumn } from 'autumn-js'
const autumn = new Autumn()
const result = await autumn.balances.delete({
customerId: "cus_123",
featureId: "api_calls",
});{
"success": true
}Body Parameters
Response
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
The ID of the customer.
The ID of the entity.
The ID of the feature.
The ID of the balance to delete.
If true, deduct the deleted balance's remaining amount from the customer's other balances for the same feature after deletion.
Target a specific balance by its reset interval. Use when the customer has multiple balances for the same feature with different reset intervals.
Available options:
one_off, minute, hour, day, week, month, quarter, semi_annual, year Response
200 - application/json
OK
⌘I