Get balance document credits

get/v1/plan/apiCreditsCount

Deprecated: This API is deprecated and will be removed in a future version. Use the Get subscription credits API instead. The response and behavior of this operation are unchanged.

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", "Your_API_Key");

PlanClient planCredit = new PlanClient(apiClient);

var billingViewModel = planCredit.GetApiCreditsCount();

import boldsign

configuration = boldsign.Configuration(host = "https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    plan_api = boldsign.PlanApi(api_client)
    billing_view_model = plan_api.api_credits_count()

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\PlanApi;

$config = new Configuration();
$config->setHost('https://api.boldsign.com');
$config->setApiKey('YOUR_API_KEY');

$plan_api = new PlanApi($config);
$billing_view_model = $plan_api->apiCreditsCount();

ApiClient client = Configuration.getDefaultApiClient();
client.setBasePath("https://api.boldsign.com"); 
client.setApiKey("YOUR_API_KEY");
            
PlanApi planApi = new PlanApi(client);
BillingViewModel billingViewModel = planApi.apiCreditsCount();

import { PlanApi } from "boldsign";

const planApi = new PlanApi("https://api.boldsign.com");
planApi.setApiKey("YOUR_API_KEY");

const billingViewModel = planApi.apiCreditsCount();

Example response

200 Success

{
  "BalanceCredits": 100
}