Get a Project Balance | Deepgram's Docs

GET/v1/projects/{project_id}/balances/{balance_id}Get a Project Balance

Retrieves details about the specified balance

Parameters

project_idstringpathrequired

The unique identifier of the project

balance_idstringpathrequired

The unique identifier of the balance

Responses

objectGetProjectBalanceV1Response

GetProjectBalanceV1Response

amountnumber · double

The amount of the balance

default 0

balance_idstring

The unique identifier of the balance

purchase_order_idstring

Description or reference of the purchase

unitsstring

The units of the balance, such as "USD"

Example response

{
  "amount": 0,
  "balance_id": "string",
  "purchase_order_id": "string",
  "units": "string"
}

valueErrorResponse

ErrorResponse

oneOf · 3 options

Option 1stringErrorResponseTextError

ErrorResponseTextError

Option 2objectErrorResponseLegacyError

ErrorResponseLegacyError

err_codestring

The error code

err_msgstring

The error message

request_idstring

The request ID

Option 3objectErrorResponseModernError

ErrorResponseModernError

categorystring

The category of the error

detailsstring

A description of the error

messagestring

A message about the error

request_idstring

The unique identifier of the request

Example response

{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

balance_idrequiredpath parameter

curl -X GET 'https://agent.deepgram.com/v1/projects/string/balances/string'

const response = await fetch('https://agent.deepgram.com/v1/projects/string/balances/string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://agent.deepgram.com/v1/projects/string/balances/string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://agent.deepgram.com/v1/projects/string/balances/string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://agent.deepgram.com/v1/projects/string/balances/string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://agent.deepgram.com/v1/projects/string/balances/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://agent.deepgram.com/v1/projects/string/balances/string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://agent.deepgram.com/v1/projects/string/balances/string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://agent.deepgram.com/v1/projects/string/balances/string");
using var response = await client.SendAsync(request);

{
  "amount": 0,
  "balance_id": "string",
  "purchase_order_id": "string",
  "units": "string"
}

{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}