billing

Get Billing Summary

Get billing summary for caller's organization.

get/api/v1/billing

Request

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

Response

Successful Response

balance_microsinteger required
plan_namestring nullable required
plan_idstring uuid nullable required
checks_per_periodinteger nullable required
checks_usedinteger nullable required
period_startstring date-time nullable required
period_endstring date-time nullable required
price_per_extra_check_microsinteger nullable required
current_plan_is_customboolean
is_suspendedboolean
scheduled_next_plan_idstring uuid nullable
scheduled_next_plan_namestring nullable
scheduled_effective_atstring date-time nullable
can_create_scanboolean
block_reason'no_subscription' | 'suspended' | 'insufficient_funds'

Why a scan admission decision came back allowed=False.

billing_modestring
credit_limit_microsinteger
effective_minimum_balance_microsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.