---
title: "Read USD workspace settings"
method: GET
path: "/billing/v1/bring-your-own-keys/settings"
tags: ["Settings"]
---

# Read USD workspace settings

`GET /billing/v1/bring-your-own-keys/settings`

## Request

- Base URL: `https://api.langdock.com`
- URL: `https://api.langdock.com/billing/v1/bring-your-own-keys/settings`
- Auth: HTTP bearer

## Response `200`

Successful response.

- ByokSettings: USD included and extra chat/agent usage; excludes workflow, API, and backbone-model usage. Weekly budgets are monthly / 4; session budgets are weekly / 3 and null when disabled. PATCH returns null spending; GET retrieves spending.
  - `currency` 'USD', required
  - `usageRequestsEnabled` boolean, required
  - `workspaceUsageLimit` union, required
    - object
      - `type` 'limited', required
      - `amount` number, required
    - object
      - `type` 'unlimited', required
  - `monthlyBudgetPerPlan` ByokPlanLimits, required
    - `standard` union, required
      - object
        - `type` 'limited', required
        - `amount` number, required
      - object
        - `type` 'unlimited', required
    - `power_user` union, required
      - object
        - `type` 'limited', required
        - `amount` number, required
      - object
        - `type` 'unlimited', required
  - `sessionLimitsEnabled` boolean, required
  - `agentLimitBehavior` AgentLimitBehavior, required: Forcing switch_model requires a valid fallback model. null forced uses each agent setting. fallbackModelId is the configured override; null uses the workspace backbone fallback.
    - `forced` 'switch_model' | 'block_usage' | 'null', nullable, required
    - `fallbackModelId` string, uuid, nullable, required
  - `weeklyBudgetPerPlan` ByokPlanLimits, required
    - `standard` union, required
      - object
        - `type` 'limited', required
        - `amount` number, required
      - object
        - `type` 'unlimited', required
    - `power_user` union, required
      - object
        - `type` 'limited', required
        - `amount` number, required
      - object
        - `type` 'unlimited', required
  - `sessionBudgetPerPlan` object, nullable, required
    - `standard` union, required
      - object
        - `type` 'limited', required
        - `amount` number, required
      - object
        - `type` 'unlimited', required
    - `power_user` union, required
      - object
        - `type` 'limited', required
        - `amount` number, required
      - object
        - `type` 'unlimited', required
  - `usagePeriod` Period, required
    - `start` string, date-time, required
    - `end` string, date-time, required
  - `usagePeriodSpend` number, nullable, required

## Other responses

- `400`: Invalid body/query, unknown fields, empty PATCH, invalid limit, invalid bulk member IDs, or a cursor outside this workspace (INVALID_CURSOR).
- `401`: Missing or invalid authentication.
- `403`: Missing Billing scope, personal key, unavailable feature, missing active service-account Admin authority, or email filter without the USER_MANAGEMENT_API scope.
- `404`: Resource not in this workspace, inactive/non-human user, privacy-hidden agent, usage request not found for that member, or endpoint unavailable in this mode.
- `405`: Unsupported HTTP method.
- `409`: Workspace mode differs from the requested mode. details.mode identifies the workspace mode.
- `429`: API rate limit exceeded.

## Changes

- **2026-11-03** `c62bf90b4013`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/langdock/apis/langdock-api/changes/billing/v1/bring-your-own-keys/settings/get.md)

---

[API](https://skmtc.dev/langdock/apis/langdock-api.md) - [All operations](https://skmtc.dev/langdock/apis/langdock-api/llms.txt) - [OpenAPI document](https://skmtc.dev/langdock/apis/langdock-api/revisions/c62bf90b4013?raw)