USuseautumn
balances

POST /v1/balances.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).

Request

Headers

x-api-versionstring required

Request body

customer_idstring required

The ID of the customer.

entity_idstring

The ID of the entity.

feature_idstring

The ID of the feature.

balance_idstring

The ID of the balance to delete.

recalculate_balancesboolean

If true, deduct the deleted balance's remaining amount from the customer's other balances for the same feature after deletion.

interval'one_off' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'semi_annual' | 'year'

Target a specific balance by its reset interval. Use when the customer has multiple balances for the same feature with different reset intervals.

Example request

{
  "customer_id": "cus_123",
  "feature_id": "api_calls"
}

Response

OK

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.