Get Project Billing Breakdown

GET/v1/projects/{project_id}/billing/breakdownGet Project Billing Breakdown

Retrieves the billing summary for a specific project, with various filter options or by grouping options.

Parameters

project_idstringpathrequired

The unique identifier of the project

startstring · datequery

Start date of the requested date range. Format accepted is YYYY-MM-DD

endstring · datequery

End date of the requested date range. Format accepted is YYYY-MM-DD

accessorstringquery

Filter for requests where a specific accessor was used

deploymentstringquery

Filter for requests where a specific deployment was used

one of "hosted", "beta", "self-hosted"

tagstringquery

Filter for requests where a specific tag was used

line_itemstringquery

Filter requests by line item (e.g. streaming::nova-3)

groupingarrayquery

Group billing breakdown by one or more dimensions (accessor, deployment, line_item, tags)

Responses

objectBillingBreakdownV1Response

BillingBreakdownV1Response

endstring · daterequired

End date of the billing summary period

resolutionobjectrequired

Show child attributes

amountnumber · doublerequired

Amount of units

unitsstringrequired

Time unit for the resolution

resultsarray of objectrequired

Show child attributes

Show array items

dollarsstringrequired

USD cost of the billing for this grouping

groupingobjectrequired

Show child attributes

accessornull | string

Optional accessor identifier, null unless grouped by accessor.

deploymentnull | string

Optional deployment identifier, null unless grouped by deployment.

endstring · date

End date for this group

line_itemnull | string

Optional line item identifier, null unless grouped by line item.

startstring · date

Start date for this group

tagsarray of string

Optional list of tags, null unless grouped by tags.

Show child attributes

startstring · daterequired

Start date of the billing summmary period

Example response

{
  "end": "2026-06-09",
  "resolution": {
    "amount": 0,
    "units": "string"
  },
  "results": [
    {
      "dollars": "string",
      "grouping": {
        "accessor": "string",
        "deployment": "string",
        "end": "2026-06-09",
        "line_item": "string",
        "start": "2026-06-09",
        "tags": [
          "string"
        ]
      }
    }
  ],
  "start": "2026-06-09"
}

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

startquery parameter

endquery parameter

accessorquery parameter

deploymentquery parameter

tagquery parameter

line_itemquery parameter

groupingquery parameter

curl -X GET 'https://agent.deepgram.com/v1/projects/string/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=string'

const response = await fetch('https://agent.deepgram.com/v1/projects/string/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://agent.deepgram.com/v1/projects/string/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://agent.deepgram.com/v1/projects/string/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=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/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=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/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=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/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=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/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=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/billing/breakdown?accessor=string&deployment=beta&end=2026-06-09&grouping=%5B%22accessor%22%5D&line_item=string&start=2026-06-09&tag=string");
using var response = await client.SendAsync(request);

{
  "end": "2026-06-09",
  "resolution": {
    "amount": 0,
    "units": "string"
  },
  "results": [
    {
      "dollars": "string",
      "grouping": {
        "accessor": "string",
        "deployment": "string",
        "end": "2026-06-09",
        "line_item": "string",
        "start": "2026-06-09",
        "tags": [
          "string"
        ]
      }
    }
  ],
  "start": "2026-06-09"
}

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