FAfax
Accounts

Get user plan

Changed on

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)

get/accounts/{user_id}/plan

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/accounts/{user_id}/plan
  • Auth
    • 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
    • or HTTP bearer

Path parameters

user_idstring required

User ID to get plan information about. For your own account use 'self'

Response

Object containing user plan type and permission flags

plan_type'free' | 'basic' | 'premium' | 'business' | 'enterprise' | 'unknown' required

Current plan type

is_adminboolean required

Whether the user has admin permissions (manage_plan or manage_hierarchy).

is_ownerboolean required

Whether the user has owner permissions (assign_admin, manage_plan, or manage_hierarchy).

Example response

{
  "plan_type": "enterprise",
  "is_admin": true,
  "is_owner": true
}

Changes