Error

A valid request URL is required to generate request examples

{
  "feature_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "feature_key": "<string>",
  "limit": 123,
  "unlimited": true,
  "included_quantity": 123
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Catalogue

Set a feature on a plan

Requires billing:write. Says that a plan carries a feature, and with how much of it. One cell of the pricing matrix.

An upsert, because a screen toggling a cell does not know whether that cell already had a row and should not have to. The feature’s kind decides which number the body may carry, and it is read from the feature rather than taken from you:

boolean — no number at all. It is included or it is not.
metered — limit is required. -1 is unlimited; 0 is a real limit, none at all.
credit — included_quantity is required: how many units the plan grants per period.

Sending the wrong number for the kind is refused rather than ignored, in both directions.

PUT

organization

catalogue

plans

{planId}

features

{featureId}

Error

A valid request URL is required to generate request examples

{
  "feature_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "feature_key": "<string>",
  "limit": 123,
  "unlimited": true,
  "included_quantity": 123
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Autorizações

Authorization

string

header

obrigatório

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

Cabeçalhos

X-Organization-Id

string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing. Absent, the session's default organization answers.

Parâmetros de caminho

planId

string<uuid>

obrigatório

The plan.

featureId

string<uuid>

obrigatório

The feature it carries.

Parâmetros de consulta

environment

enum<string>

padrão:live

Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.

Opções disponíveis:

live,

test

Corpo

application/json

limit

integer<int64> | null

The ceiling, on a metered feature. -1 is unlimited. Omit on the other kinds.

included_quantity

integer<int64> | null

How many units the plan grants per period, on a credit feature. Omit on the other kinds.

Resposta

The cell.

One cell of the plan/feature matrix: how much of a feature a plan carries. A feature a plan does not carry is simply absent from the list.

feature_id

string<uuid>

feature_key

string

kind

enum<string>

The feature's kind, which decides which of the two numbers below applies.

Opções disponíveis:

boolean,

metered,

credit

limit

integer<int64> | null

The ceiling, on a metered feature; null on the other kinds. -1 is unlimited and 0 is a real limit — none at all.

unlimited

boolean

Whether limit is the unlimited sentinel, so a client never has to know the number.

included_quantity

integer<int64> | null

How many credits the plan grants per period, on a credit feature; null otherwise.

Add a price to a plan Remove a feature from a plan

⌘I

Visão geral

Endpoints

Set a feature on a plan

Autorizações

Cabeçalhos

Parâmetros de caminho

Parâmetros de consulta

Corpo

Resposta