40 lines
1.3 KiB
Plaintext
40 lines
1.3 KiB
Plaintext
---
|
|
title: "Delete Balance"
|
|
openapi: "openapi POST /v1/balances.delete"
|
|
---
|
|
|
|
import { DynamicParamField } from "/snippets/dynamic-param-field.jsx";
|
|
import { DynamicResponseField } from "/snippets/dynamic-response-field.jsx";
|
|
import { DynamicResponseExample } from "/snippets/dynamic-response-example.jsx";
|
|
|
|
### Body Parameters
|
|
|
|
<DynamicParamField body="customer_id" type="string" required>
|
|
The ID of the customer.
|
|
</DynamicParamField>
|
|
|
|
<DynamicParamField body="entity_id" type="string">
|
|
The ID of the entity.
|
|
</DynamicParamField>
|
|
|
|
<DynamicParamField body="feature_id" type="string">
|
|
The ID of the feature.
|
|
</DynamicParamField>
|
|
|
|
<DynamicParamField body="balance_id" type="string">
|
|
The ID of the balance to delete.
|
|
</DynamicParamField>
|
|
|
|
<DynamicParamField body="recalculate_balances" type="boolean">
|
|
If true, deduct the deleted balance's remaining amount from the customer's other balances for the same feature after deletion.
|
|
</DynamicParamField>
|
|
|
|
<DynamicParamField body="interval" type="'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.
|
|
</DynamicParamField>
|
|
|
|
|
|
### Response
|
|
|
|
<DynamicResponseField name="success" type="boolean" />
|