---
title: "Get user plan"
method: GET
path: "/accounts/{user_id}/plan"
tags: ["Accounts"]
---

# Get user plan

`GET /accounts/{user_id}/plan`

## Request

- Base URL: `https://restapi.fax.plus/v3`
- URL: `https://restapi.fax.plus/v3/accounts/{user_id}/plan`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all`
    - Token URL: `https://accounts.fax.plus/token` scopes: `all`
  - HTTP bearer

Get the plan type for an account. For Business and Enterprise plans, the response also includes permission flags indicating whether the user is an admin or owner. (Permitted scopes: **fax:all:read**, **fax:member:read**, **fax:user:read**)

## Path parameters

- `user_id` string, required

## Response `200`

Object containing user plan type and permission flags

- AccountPlan: User plan and permission flags
  - `plan_type` 'free' | 'basic' | 'premium' | 'business' | 'enterprise' | 'unknown', required: Current plan type
  - `is_admin` boolean, required: Whether the user has admin permissions (manage_plan or manage_hierarchy).
  - `is_owner` boolean, required: Whether the user has owner permissions (assign_admin, manage_plan, or manage_hierarchy).

## Other responses

- `400`: Error object in case there's a problem with given data
- `401`: Error object in case there's a problem with the authorization
- `403`: Error object in case there's a problem with given data
- `500`: Error object in case there's a server error

## Changes

- **2026-11-03** `95a35a892239`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fax/apis/fax-plus-rest-api/changes/accounts/:user_id/plan/get.md)

---

[API](https://skmtc.dev/fax/apis/fax-plus-rest-api.md) - [All operations](https://skmtc.dev/fax/apis/fax-plus-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fax/apis/fax-plus-rest-api/revisions/95a35a892239?raw)