Get balance document credits

get/v1/plan/apiCreditsCount

Returns the number of remaining API credits after usage. These credits can be used to determine whether you possess sufficient balance left to send API requests or not.

Code snippet

curl -X GET 'https://api.boldsign.com/v1/plan/apiCreditsCount' \
-H 'accept: application/json' \
-H 'X-API-KEY: {your-api-key}'
ApiClient apiClient = new ApiClient("https://api.boldsign.com", "API-KEY");
PlanClient planCredit = new PlanClient(apiClient);
var billingViewModel = planCredit.GetApiCreditsCount();
import boldsign

configuration = boldsign.Configuration(
    api_key = "YOUR_API_KEY"
)

with boldsign.ApiClient(configuration) as api_client:
    
    plan_api = boldsign.PlanApi(api_client)
    
    plan_api_credits_count_response = plan_api.api_credits_count()
const axios = require('axios'); 
const response = await axios.get('https://api.boldsign.com/v1/plan/apiCreditsCount', { 

    headers: { 
        'accept': 'application/json', 
        'Authorization': 'Bearer <authtoken>' 
    } 
}); 

Example response

200 Success

{
  "BalanceCredits": 100
}