> ## Documentation Index > Fetch the complete documentation index at: https://docs.userkit.dev/llms.txt > Use this file to discover all available pages before exploring further. # Create a feature > Requires `billing:write`. Declares one thing your product does, that your plans may or may not include. Yours, not UserKit's — the key is a string **your** code gates on, and this namespace never meets the one our own plans use. The `kind` decides what else the feature must carry, in both directions: - `boolean` — no `unit_name` and no `reset_period`. It counts nothing. - `metered` — both are required. A limit with no unit is a number nobody can read, and the reset period is what makes "how much this period" answerable. - `credit` — `unit_name` is required and `reset_period` is forbidden: a balance is granted and spent, never reset. The grant's cadence belongs to the plan. How a feature is measured is permanent once created — see `PATCH /v1/organization/catalogue/features/{id}`. A feature created here is on no plan. Put it on one with `PUT /v1/organization/catalogue/plans/{planId}/features/{featureId}`. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/organization/catalogue/features openapi: 3.1.0 info: title: UserKit API version: 1.0.0 description: >- The HTTP surface of UserKit. Two planes share one API. The **staff plane** is what a human uses in the panel: users, organizations, roles, members, keys. The **customer plane** is what a developer's own product uses: contacts, identities, hosted or federated sign-in. Every error answers the same envelope — `{"error": {"code", "message"}}`. The `code` is a stable contract to branch on; the `message` is for a person and may change. servers: - url: '{baseUrl}' description: The API host. variables: baseUrl: default: https://api.userkit.dev description: Base URL of the API, no trailing slash. security: - sessionToken: [] tags: - name: Authentication description: >- Public sign-up, sign-in, two-factor and password recovery for staff accounts. - name: Session description: >- The active session: who the caller is, which organization they are in, and signing out. - name: Account description: The caller's own account — profile, password, sessions, avatar. - name: Two-factor description: >- TOTP setup, activation and recovery codes. Returns 501 when two-factor is unavailable on the server. - name: Organizations description: The organizations a user belongs to, and the active one. - name: Environments description: >- The live and test environments seeded with every organization, and their identity settings. - name: Members description: Memberships and invitations. - name: Roles description: Roles and the permission catalogue they draw from. - name: Audit log description: >- What staff did inside an organization. Append-only, and read behind its own permission. - name: API keys description: Secret keys (`uk_sk_…`) and publishable keys (`uk_pk_…`). - name: Contacts (staff session) description: >- The staff view of the customer plane, opened by a staff session. Reads take `?environment=` as an explicit view parameter. - name: Contacts (API key) description: >- The machine surface, authenticated by an API key. The environment is the key's environment and cannot be named by the caller. - name: Customer plane description: >- Called from the developer's own pages with a publishable key: boot, magic link, and the contact's own session. - name: Hosted auth description: >- Sign-up, sign-in, verification and recovery for contacts, when UserKit owns the account. - name: Customer teams description: >- A customer is a team. Its roster, its invitations and its two roles — owner and member — administered by the contact's own session. The active customer travels in `X-Customer-Id`. - name: Webhooks description: >- Outbound webhooks: endpoints, the published event catalogue, the delivery log, replay and test sends. Never gated by a plan — webhooks are a developer primitive. - name: Catalogue description: >- The plans, prices and features **you** sell to your own customers. Per environment, a price per currency, and `recurring` or `one_time`. Distinct from the plan you are on with UserKit, which is `GET /v1/organization/entitlements`. - name: Subscriptions description: >- What one of **your** customers is paying you, mirrored from the gateway that charges them. The gateway is the truth about money — it holds the schedule, runs the retries and decides what a proration is worth — so these routes ask it to change something and answer with what it then said. `provider_synced_at` is how stale the copy admits to being. - name: Provider webhooks description: >- Where a payment provider delivers to. Not a surface you call — it is a URL you paste into the provider's dashboard, which is why it sits outside `/v1`: a version bump must never mean editing a setting in somebody else's product. Signed with the secret of the connection named in the path, and safe to retry. - name: Entitlements description: >- What one of **your** customers may do, resolved: the plan their subscription carries, plus the overrides you promised them on top. This is the read your own gate calls, so it is cached and answers in one round trip. It is a different question from `GET /v1/organization/entitlements`, which is the plan **you** are on with UserKit — two catalogues, same word, different money. paths: /v1/organization/catalogue/features: post: tags: - Catalogue summary: Create a feature description: >- Requires `billing:write`. Declares one thing your product does, that your plans may or may not include. Yours, not UserKit's — the key is a string **your** code gates on, and this namespace never meets the one our own plans use. The `kind` decides what else the feature must carry, in both directions: - `boolean` — no `unit_name` and no `reset_period`. It counts nothing. - `metered` — both are required. A limit with no unit is a number nobody can read, and the reset period is what makes "how much this period" answerable. - `credit` — `unit_name` is required and `reset_period` is forbidden: a balance is granted and spent, never reset. The grant's cadence belongs to the plan. How a feature is measured is permanent once created — see `PATCH /v1/organization/catalogue/features/{id}`. A feature created here is on no plan. Put it on one with `PUT /v1/organization/catalogue/plans/{planId}/features/{featureId}`. operationId: createCatalogueFeature parameters: - $ref: '#/components/parameters/OrganizationHeader' - $ref: '#/components/parameters/EnvironmentQuery' requestBody: required: true content: application/json: schema: type: object required: - key - name - kind properties: key: type: string maxLength: 64 description: >- Lowercase letters, digits, `_`, `-` and `.`. Unique within the environment. What your own code compares against. example: api_calls name: type: string description: type: string default: '' kind: type: string enum: - boolean - metered - credit unit_name: type: string description: >- What one unit is called (`seats`, `runs`, `tokens`). Required for `metered` and `credit`, forbidden for `boolean`. reset_period: type: string enum: - day - week - month - year - billing_period description: >- Required for `metered` and forbidden for the other kinds. `billing_period` is renewal to renewal rather than a calendar unit. example: key: api_calls name: API calls kind: metered unit_name: calls reset_period: billing_period responses: '201': description: The feature. content: application/json: schema: $ref: '#/components/schemas/CatalogueFeature' '400': description: >- `invalid_request` — the key is empty or malformed, the name is empty, the kind is not one of the three, or the unit and reset period do not match the kind. content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '409': description: >- `feature_key_taken` — this environment already has a feature with that key. content: application/json: schema: $ref: '#/components/schemas/Error' components: parameters: OrganizationHeader: name: X-Organization-Id in: header required: false schema: type: string description: >- 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. EnvironmentQuery: name: environment in: query required: false schema: type: string enum: - live - test default: live description: >- 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. schemas: CatalogueFeature: type: object description: >- One thing your product does, that your plans may or may not include. Yours, not UserKit's — the key is a string **your** code gates on. properties: id: type: string format: uuid key: type: string description: >- Lowercase letters, digits, `_`, `-` and `.`. What your own code compares against. example: api_calls name: type: string description: type: string kind: type: string enum: - boolean - metered - credit description: >- `boolean` is on or off. `metered` is counted against a ceiling that resets. `credit` is spent from a balance — a counter answers “how much this period”, a balance answers “how much is left”. unit_name: type: string description: >- What one unit is called (`seats`, `runs`, `tokens`). Empty on a `boolean` feature and required on the others: a limit with no unit is a number nobody can read. reset_period: type: - string - 'null' enum: - day - week - month - year - billing_period - null description: >- How a `metered` feature's counter is bucketed; `null` for the other kinds. It belongs to the feature rather than to the plan, so a counter keeps its shape when a customer changes plan mid-period. archived: type: boolean created_at: type: string format: date-time Error: type: object description: Every error in this API answers this envelope. properties: error: type: object properties: code: type: string description: Stable. Branch on this. message: type: string description: For a person. May change. required: - code - message required: - error example: error: code: forbidden message: your role does not allow this action responses: Unauthorized: description: >- `unauthorized` — missing, malformed or expired credential. A well-formed credential from the wrong family says so: "this endpoint expects a staff session token, not an organization API key". content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: '`forbidden` — your role does not allow this action.' content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: sessionToken: type: http scheme: bearer description: >- A staff session token, `uk_st_…`. Minted by sign-up, sign-in or the two-factor exchange. ````