> ## Documentation Index
> Fetch the complete documentation index at: https://docs.langdock.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Included User

> Read one member's plan, configured extra usage limit, and effective limit

List active human members, change a plan, and set the extra usage limit. Amounts are euros.

The calls use the workspace API key's `BILLING_API` scope. Writes run as the key's service account owner. This API does not invite or deactivate members. Use the [User Management API](https://docs.langdock.com/en/developer/user-management-api/user-management-overview.md) for that.

> [!NOTE]
>
> Call these routes when `GET /billing/v1/mode` returns `ai-models-included`. Dedicated deployments always return `bring-your-own-keys`, including when Langdock manages the model keys. The other mode returns `409` with `code` `BILLING_MODE_MISMATCH`.

## Base URL

```
https://api.langdock.com/billing/v1/ai-models-included/users/{userId}
```

## Prerequisites

* **API key** with the `BILLING_API` scope
* The key owner is a service account that has not been deleted and has an active Admin membership
* `USER_MANAGEMENT_API` on the same key when you need `email`, `name`, or an email filter

A member object includes `email` and `name` only when the key also has `USER_MANAGEMENT_API`. Without that scope, those fields are omitted. `name` may be `null` when it is included.

```json theme={null}
{
  "id": "11111111-1111-4111-8111-111111111111",
  "email": "jane@example.com",
  "name": "Jane Doe",
  "plan": "business_max",
  "extraUsageLimit": {
    "configured": { "type": "inherit" },
    "effective": {
      "type": "limited",
      "amount": 150,
      "source": { "type": "plan" }
    }
  },
  "extraUsagePeriodSpend": 12.4
}
```

`plan` is `business` (**Business**) or `business_max` (**Business Max**).

`configured` is the limit stored on the member: `inherit`, `limited`, or `unlimited`. `inherit` means the member has no personal cap. An explicit `limited` or `unlimited` value overrides the plan and every group.

`effective` is the limit that applies. With `inherit`, the higher of the plan default and the member's group limits applies. An unlimited value wins over a limited one. When the amounts match, a group wins over the plan. When two groups set the same amount, the source is the group whose name comes first. `source.type` is `plan`, `group`, `user`, or `workspace`. A `group` source also includes `groupId` and `groupName`.

`source` is `user` when the member has an explicit cap. An unlimited group does not override that cap. `source` is `workspace` and the effective amount is zero when extra usage is turned off for the workspace. An unlimited member or group limit does not override that switch or the workspace extra usage cap.

`extraUsagePeriodSpend` is extra usage in the current period. It is `null` when the workspace hides per user spend. A user who is not an active human member returns `404`.

> [!NOTE]
>
> Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on [API Key Best Practices](https://docs.langdock.com/en/admin/ai-adoption-and-rollout/best-practices/api-key-best-practices.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.