Billing

Get the account's entitlement

GET

https://api.costfluent.com

/v1/entitlement

Bearer (API token)

The tier, every limit it carries, any limit raised for this account, and the published ladder so a caller can see what the next plan lifts.

Needs an organization token with viewOrganization.

Get the account's entitlement › Responses

Success

EntitlementResponse

planCode

string · required

planName

string · required

status

string · required

currency

string · pattern: ^[A-Z]{3}$ · required

features

string[] · required

overriddenLimits

string[] · required

ingestionHalted

boolean · required

ingestionHaltedReason

string · required

currentPeriodStart

string · date · required

currentPeriodEnd

string · date · required

PlanLadderEntryResponse[] · required

spendCeiling

string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

historyDays

integer | null · int32

maxConnections

integer | null · int32

maxAllocationRules

integer | null · int32

maxBackfillMonths

integer | null · int32

maxRowsPerMonth

integer | null · int64

maxBytesStored

integer | null · int64

bandPlanCode

string | null

GET/v1/entitlement

curl https://api.costfluent.com/v1/entitlement \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "planCode": "planCode",
  "planName": "planName",
  "status": "status",
  "currency": "currency",
  "spendCeiling": "spendCeiling",
  "historyDays": 0,
  "maxConnections": 0,
  "maxAllocationRules": 0,
  "maxBackfillMonths": 0,
  "maxRowsPerMonth": 0,
  "maxBytesStored": 0,
  "features": [
    "string"
  ],
  "overriddenLimits": [
    "string"
  ],
  "ingestionHalted": true,
  "ingestionHaltedReason": "ingestionHaltedReason",
  "bandPlanCode": "bandPlanCode",
  "currentPeriodStart": "2024-08-25",
  "currentPeriodEnd": "2024-08-25",
  "ladder": [
    {
      "code": "code",
      "name": "name",
      "priceAmount": "priceAmount",
      "currency": "currency",
      "spendCeiling": "spendCeiling",
      "historyDays": 0,
      "maxConnections": 0,
      "maxAllocationRules": 0,
      "features": [
        "string"
      ],
      "selfServeAvailable": true
    }
  ]
}

json

application/json

Get the account's metered usage

GET

https://api.costfluent.com

/v1/usage

Bearer (API token)

The same numbers the caps are enforced against, so a script can check headroom rather than discover a limit by being refused.

Needs an organization token with viewOrganization.

Get the account's metered usage › Responses

Success

UsageResponse

periodStart

string · date · required

currency

string · pattern: ^[A-Z]{3}$ · required

trackedSpend

string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

isSpendComplete

boolean · required

unconvertedCurrencies

string[] · required

rowsIngested

integer · int64 · required

bytesStored

integer · int64 · required

connectionCount

integer · int32 · required

activeUserCount

integer · int32 · required

UsageHistoryEntryResponse[] · required

computedAt

string | null · date-time

averageTrackedSpend

string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

bandPlanCode

string | null

Audit Logs Budgets