Set Balance

Set a user's wallet balance to a specific value within a project. This endpoint allows administrators to directly set a user's balance rather than adjusting by a delta amount.

POST/v2/projects/{project_id}/balance/adjust

Authorization

Bearer TokenRequired

Path Parameters

project_idstringRequired

The unique identifier of the project.

Request Body

user_idstringRequired

The user ID to set balance for.

new_balancestringRequired

The new balance value to set (e.g., '10.00').

reasonstring

Optional reason for the balance change.

Request

curl -X POST "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/balance/adjust" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "123456789012345678",
    "new_balance": "10.00",
    "reason": "Promotional credit"
  }'

const project_id = 'YOUR_PROJECT_ID';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/balance/adjust`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_id: '123456789012345678',
    new_balance: '10.00',
    reason: 'Promotional credit'
  })
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
response = requests.post(
    f'https://api.botsubscription.com/v2/projects/{project_id}/balance/adjust',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'user_id': '123456789012345678',
        'new_balance': '10.00',
        'reason': 'Promotional credit'
    }
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/balance/adjust");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'user_id' => '123456789012345678',
    'new_balance' => '10.00',
    'reason' => 'Promotional credit'
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Balance set successfullyapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "POST",
  "path": "/v2/projects/YOUR_PROJECT_ID/balance/adjust",
  "code": 200,
  "message": "Balance adjusted successfully",
  "data": {
    "previous_balance": "0",
    "new_balance": "10",
    "adjustment": "10",
    "user_id": "123456789012345678",
    "transaction_id": "22222222-2222-2222-2222-222222222222",
    "reason": "Promotional credit"
  }
}

Permission deniedapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "POST",
  "path": "/v2/projects/YOUR_PROJECT_ID/balance/adjust",
  "code": 403,
  "error": {
    "error_code": "FORBIDDEN",
    "message": "Missing required permission: balance:adjust"
  }
}

User not foundapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "POST",
  "path": "/v2/projects/YOUR_PROJECT_ID/balance/adjust",
  "code": 404,
  "error": {
    "error_code": "NOT_FOUND",
    "message": "User not found"
  }
}

Last updated: January 15, 2026

API Endpoint

Set Balance

Authorization

Path Parameters

Request Body