Skip to main content
GET
/
plan-tiers
List plan tiers
curl --request GET \
  --url https://app.usechar.ai/api/plan-tiers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "polar_product_id": "<string>",
    "max_seats": 0,
    "included_seats": 0,
    "sso_enabled": true,
    "scim_enabled": true,
    "audit_logs_enabled": true,
    "custom_domains_enabled": true,
    "max_sites": 0,
    "max_end_users": 0,
    "display_order": 0,
    "is_public": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.usechar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

WorkOS JWT token. Obtain via WorkOS AuthKit authentication flow. The token must include organization_id claim for organization-scoped endpoints.

Response

OK

id
string
required

Plan tier identifier (e.g., free, enterprise).

name
string
required

Human-readable plan name.

polar_product_id
string | null
required

Polar product ID associated with this tier (null for free plan).

max_seats
integer
required

Maximum number of seats allowed (0 means unlimited).

Required range: -9007199254740991 <= x <= 9007199254740991
included_seats
integer
required

Seats included in the base price for the tier.

Required range: -9007199254740991 <= x <= 9007199254740991
sso_enabled
boolean
required

Whether SSO is enabled for this plan tier.

scim_enabled
boolean
required

Whether SCIM directory sync is enabled for this plan tier.

audit_logs_enabled
boolean
required

Whether audit logs are enabled for this plan tier.

custom_domains_enabled
boolean
required

Whether custom domains are enabled for this plan tier.

max_sites
integer
required

Maximum number of sites allowed (0 means unlimited).

Required range: -9007199254740991 <= x <= 9007199254740991
max_end_users
integer
required

Maximum number of end users allowed (0 means unlimited).

Required range: -9007199254740991 <= x <= 9007199254740991
display_order
integer
required

Ordering index for displaying tiers in the UI.

Required range: -9007199254740991 <= x <= 9007199254740991
is_public
boolean
required

Whether this tier is visible on public pricing pages.

created_at
string<date-time>
required

Timestamp when the plan tier was created.

updated_at
string<date-time>
required

Timestamp when the plan tier was last updated.