---
title: "Get Billing Summary"
method: GET
path: "/api/v1/billing"
tags: ["billing"]
---

# Get Billing Summary

`GET /api/v1/billing`

## Request

- Base URL: `https://app.kaminari.ad`
- URL: `https://app.kaminari.ad/api/v1/billing`
- Auth: HTTP bearer

Get billing summary for caller's organization.

## Response `200`

Successful Response

- BillingSummaryResponse: Aggregated billing state for an organization.
  - `balance_micros` integer, required
  - `plan_name` string, nullable, required
  - `plan_id` string, uuid, nullable, required
  - `checks_per_period` integer, nullable, required
  - `checks_used` integer, nullable, required
  - `period_start` string, date-time, nullable, required
  - `period_end` string, date-time, nullable, required
  - `price_per_extra_check_micros` integer, nullable, required
  - `current_plan_is_custom` boolean
  - `is_suspended` boolean
  - `scheduled_next_plan_id` string, uuid, nullable
  - `scheduled_next_plan_name` string, nullable
  - `scheduled_effective_at` string, date-time, nullable
  - `can_create_scan` boolean
  - `block_reason` 'no_subscription' | 'suspended' | 'insufficient_funds': Why a scan admission decision came back ``allowed=False``.
  - `billing_mode` string
  - `credit_limit_micros` integer
  - `effective_minimum_balance_micros` integer

---

[API](https://skmtc.dev/kaminari/apis/kaminari-ad-api.md) · [All operations](https://skmtc.dev/kaminari/apis/kaminari-ad-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kaminari/apis/kaminari-ad-api/revisions/013f86e2fd32?raw)
