Skip to Content
kosemdocs
ReferenceAPIPlans

Get plan

Gets one of kosem's plans.

GET
/v1/plans/{plan}

Gets one of kosem's plans.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

plan*string

The plan: hobby, pro, team or enterprise.

Value in"hobby""pro""team""enterprise"

Response Body

OK

application/json
  1. response
allowances*array<>

What is free each calendar month (UTC), and the price of each past it, by SKU.

buysCredits*boolean

Whether an organization on the plan can buy credits.

custom*boolean

Whether each organization's terms are agreed with kosem, as Enterprise's are: its price, credits and limits are set for each, and those here are what it starts from.

description*string

Whom the plan is for, in a sentence.

displayName*string

Name shown in user interfaces, such as Team.

features*array<>

What the plan gives of kosem's features that aren't limits, such as audit logs, as an organization's entitlements list them; its quotas are its limits.

monthlyPrice?

What each one past limit costs, paid from credits.

name*string

Resource name: plans/hobby, plans/pro, plans/team or plans/enterprise.

quotas*array<>

The most an organization on the plan can have or use at once, of each quota that depends on the plan or not, as an organization's quota infos list them.

seatPrice?

What each one past limit costs, paid from credits.

selfServe*boolean

Whether an organization's owners and billing admins move it to the plan themselves, rather than kosem's team.

starterCredits?

What each one past limit costs, paid from credits.

starterCreditsDays?integer

How many days starter credits last.

Formatint32
Example Request
curl -X GET 'https://api.kosem.ai/v1/plans/hobby'
Example Response
{
  "allowances": [
    {
      "displayName": "string",
      "limit": 0,
      "price": {
        "currencyCode": "string",
        "nanos": -999999999,
        "units": 0
      },
      "sku": "string",
      "unit": "string"
    }
  ],
  "buysCredits": true,
  "custom": true,
  "description": "string",
  "displayName": "string",
  "features": [
    {
      "displayName": "string",
      "enabled": true,
      "feature": "string",
      "type": "BOOLEAN",
      "unit": "string",
      "unlimitedZero": true,
      "value": 0
    }
  ],
  "monthlyPrice": {
    "currencyCode": "string",
    "nanos": -999999999,
    "units": 0
  },
  "name": "string",
  "quotas": [
    {
      "displayName": "string",
      "limit": 0,
      "quotaId": "string",
      "refreshInterval": "string",
      "unit": "string"
    }
  ],
  "seatPrice": {
    "currencyCode": "string",
    "nanos": -999999999,
    "units": 0
  },
  "selfServe": true,
  "starterCredits": {
    "currencyCode": "string",
    "nanos": -999999999,
    "units": 0
  },
  "starterCreditsDays": 0
}