DocsAPI ReferenceTariff/bff/tariff/current
getTariffAdmin BFF

/bff/tariff/current

Comprehensive tariff & usage report for the calling organisation. Returns tariff metadata (catalogue + per-org override + computed effective price), salesperson assignment, the current calendar-month period window, per-resource usage with limit/percent/projection/status, and the last 12 months of monthly usage counters (with gaps filled). Designed as the single source for the admin "Tariff & usage" screen.

TariffgetBffTariffCurrent

No parameters

This endpoint takes no path, query, header or body parameters.

Request

GET /bff/tariff/current

get
curl -X GET "https://api.bizkithub.com/bff/tariff/current" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "organisationId": 0,
  "tariff": {
    "id": 0,
    "code": "example_code",
    "name": "example_name",
    "position": 0,
    "monthlyPriceCzk": 0,
    "priceFrom": false,
    "requiresCustomPrice": false,
    "minCustomPriceCzk": 0,
    "commission": {
      "flatCzk": 0,
      "percent": 0
    }
  },
  "billing": {
    "effectivePriceCzk": 0,
    "catalogueMonthlyPriceCzk": 0,
    "discountPercent": 0,
    "isExpired": false,
    "expiringSoon": false
  },
  "validation": {
    "requiresCustomPrice": false,
    "minCustomPriceCzk": 0,
    "customPriceMissing": false,
    "customPriceBelowMinimum": false,
    "paidUntilMissing": false,
    "expired": false,
    "expiringSoon": false
  },
  "period": {
    "start": "example_start",
    "end": "example_end",
    "daysElapsed": 0,
    "daysTotal": 0,
    "elapsedFraction": 0
  },
  "resources": [
    {
      "key": "example_key",
      "unit": "example_unit",
      "used": 0,
      "limit": 0,
      "unlimited": false,
      "percent": 0,
      "source": "example_source"
    }
  ],
  "history": {
    "monthly": [
      {
        "periodStart": "example_periodStart",
        "ordersCount": 0,
        "emailsCount": 0,
        "aiTokensCount": 0,
        "apiRequestsCount": 0
      }
    ],
    "totals": {
      "orders": 0,
      "emails": 0,
      "aiTokens": 0,
      "apiRequests": 0
    }
  }
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key