Billing API
Burn Vendor Balance
Billing API
Burn Vendor Balance
Endpoint to burn some amount of balance for a vendor.
POST
/
public
/
v1
/
billing-service
/
vendors
/
{external-vendor-id}
/
balance
/
burn
Path Parameters
external-vendor-id
string
requiredThe External ID of the Vendor to retrieve.
Minimum length:
1Body
application/json
Basic request payload for Burning Balance.
amount
number
requiredAmount to Burn. The value must be greater or equal to the minimum currency units. For example, for USD you cannot specify 0.009, as that's less than 1 cent.
Required range:
x > 0description
string
requiredReason given to burn the amount
Minimum length:
1