Usage Summary

curl --request GET \
  --url https://api.hirebase.org/v2/billing/usage/summary

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hirebase.org/v2/billing/usage/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hirebase.org/v2/billing/usage/summary"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/billing/usage/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "billing_source": "stripe_v2",
  "plan_lookup_keys": ["plan_starter"],
  "subscription_status": "active",
  "period_start": "2026-08-02T13:16:47",
  "period_end": "2026-09-02T13:16:47",
  "meters": [
    {
      "event_name": "m_jobs_api_calls",
      "display_name": "Jobs",
      "used": 3,
      "included": 25000,
      "remaining": 24997,
      "overage_used": 0,
      "period": "month",
      "overage_mode": "block",
      "estimated_overage_cents": 0,
      "overage_currency": "usd"
    }
  ]
}

GET

billing

usage

summary

Usage Summary

curl --request GET \
  --url https://api.hirebase.org/v2/billing/usage/summary

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hirebase.org/v2/billing/usage/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hirebase.org/v2/billing/usage/summary"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hirebase.org/v2/billing/usage/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "billing_source": "stripe_v2",
  "plan_lookup_keys": ["plan_starter"],
  "subscription_status": "active",
  "period_start": "2026-08-02T13:16:47",
  "period_end": "2026-09-02T13:16:47",
  "meters": [
    {
      "event_name": "m_jobs_api_calls",
      "display_name": "Jobs",
      "used": 3,
      "included": 25000,
      "remaining": 24997,
      "overage_used": 0,
      "period": "month",
      "overage_mode": "block",
      "estimated_overage_cents": 0,
      "overage_currency": "usd"
    }
  ]
}

Returns your current billing period’s usage across every meter — what you’ve used, what your plan includes, what’s remaining, and any overage. Calls to this endpoint are not metered and don’t count against any allowance.

Requires authentication (API key or JWT).

Endpoint

GET /v2/billing/usage/summary

Response

string

"stripe_v2" for accounts on the current plan catalog; "legacy" for grandfathered accounts (whose meters show null allowances)

string | null

Your Stripe customer ID

string[]

Active plan identifiers (e.g. ["plan_starter"])

string | null

Stripe subscription status (e.g. "active")

string | null

ISO timestamp of the current billing period start. null for accounts with no subscription (free tier), whose allowances reset on the first of each calendar month (UTC). Trial accounts see the trial window.

string | null

ISO timestamp of the current billing period end (null on the free tier, see above)

array

One entry per meter, sorted alphabetically

Show child attributes

string

Meter key — one of m_jobs_api_calls, m_company_api_calls, m_insights_calls, m_salary_benchmarks, m_hiring_manager_contacts. Everything that returns jobs (search, vector, neural, company jobs, exports) rolls into m_jobs_api_calls.

string

Human-readable meter name

integer

Units used this period

integer | null

Units included in your plan

integer | null

max(0, included - used)

integer

Units used beyond the included allowance

string | null

"block" — requests return 429 once included is exhausted. "meter" — requests continue and overage is billed.

integer | null

Overage price in cents per overage_unit units (metered mode only)

integer

Estimated overage charge so far this period

Every metered API response also carries Hirebase-Usage-* headers with the same numbers for the meter that request billed — use those to track quota without polling this endpoint.

Example

curl 'https://api.hirebase.org/v2/billing/usage/summary' \
  -H 'x-api-key: YOUR_API_KEY'

{
  "billing_source": "stripe_v2",
  "plan_lookup_keys": ["plan_starter"],
  "subscription_status": "active",
  "period_start": "2026-08-02T13:16:47",
  "period_end": "2026-09-02T13:16:47",
  "meters": [
    {
      "event_name": "m_jobs_api_calls",
      "display_name": "Jobs",
      "used": 3,
      "included": 25000,
      "remaining": 24997,
      "overage_used": 0,
      "period": "month",
      "overage_mode": "block",
      "estimated_overage_cents": 0,
      "overage_currency": "usd"
    }
  ]
}

Jobs API

Expired Jobs API

Hiring Manager API

Companies API

Insights API

Salary Benchmark API

Reference Data API

Resumes

Tasks API

Billing & Usage

Error Handling

Usage Summary

Endpoint

Response

Example

​Endpoint

​Response

​Example

Endpoint

Response

Example