---
title: "Read an immutable end user's execution policy"
method: GET
path: "/credits/end-users/{externalUserId}/policy"
tags: ["End users"]
---

# Read an immutable end user's execution policy

`GET /credits/end-users/{externalUserId}/policy`

## Request

- Base URL: `https://api.paywithlocus.com/api`
- URL: `https://api.paywithlocus.com/api/credits/end-users/{externalUserId}/policy`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Returns the end user's current execution policy, or null when no policy is set. Policies are immutable; a change creates a new policy.

## Path parameters

- `externalUserId` string, required: Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

## Response `200`

Current policy or null

- EndUserPolicyEnvelope
  - `success` unknown, required
  - `externalUserId` string, required: Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.
  - `policy` EndUserPolicy, required
    - `mode` 'ask' | 'bounded' | 'unlimited', required
    - `budgetPeriod` 'hour' | 'day' | 'week' | 'month' | 'null', nullable
    - `budgetCredits` string: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `maxChargeCredits` string: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `allowProviders` string[], nullable
    - `denyProviders` string[], nullable
    - `allowEndpoints` string[], nullable
    - `denyEndpoints` string[], nullable
    - `allowModels` string[], nullable
    - `denyModels` string[], nullable
    - `maxConcurrentReservations` integer, nullable
    - `maxCallsPerPeriod` integer, nullable
    - `maxCallsPerLoop` integer, nullable
    - `id` string, uuid, required
    - `activeReservations` integer, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

---

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