Skip to main content
POST
/
public
/
v1
/
billing-service
/
vendors
/
{external-vendor-id}
/
balance
/
burn
Burn Vendor Balance
curl --request POST \
  --url https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/balance/burn \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "description": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Path Parameters

​
external-vendor-id
string
required

The External ID of the Vendor to retrieve.

Minimum string length: 1

Body

application/json

Basic request payload for Burning Balance.

​
amount
number
required

Amount 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.

​
description
string
required

Reason given to burn the amount

Minimum string length: 1

Response

Successful Response