Skip to content

Commit 18948d7

Browse files
authored
feat: add doc for seat limit based plans for Clerk Billing (#3266)
1 parent aeede62 commit 18948d7

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Plans with seat limits
3+
description: Restrict organization membership by Plan tier using seat-based limits
4+
---
5+
6+
<Include src="_partials/billing/billing-experimental" />
7+
8+
Membership limits on organizations can now be granted directly by subscribing to a Clerk Billing Plan, allowing organizations to purchase a higher membership limit in a self-serve fashion.
9+
This makes it possible to target Plans to organizations based on their specific size. For example, you may let organizations use your most affordable Plan for up to ten seats, but require them to upgrade to a more expensive Plan to get unlimited seats.
10+
11+
## Creating a Plan with a seat limit
12+
13+
To create a Plan with a seat limit:
14+
15+
1. Navigate to the [**New Organization plan**](https://dashboard.clerk.com/~/billing/plans/new/org) page in the Clerk Dashboard.
16+
1. Toggle on the **Seat-based** section.
17+
1. If you'd like to set a limit, select **Custom limit** and enter the desired value. (You need the B2B Authentication add-on to set a limit greater than 20.)
18+
1. If you'd like the Plan to allow an unlimited number of seats, select **Unlimited members**. (You need to have the B2B Authentication add-on to select this option.)
19+
20+
> [!IMPORTANT]
21+
>
22+
> - Plans created with seat limits cannot have the seat limit removed or changed. Similarly, Plans created without seat limits cannot have seat limits added after the Plan is created.
23+
> - Organizations subscribed to Plans with seat limits on them will have their membership limit set to the Plan's seat limit.
24+
> - Organizations subscribed to Plans without seat limits will have their membership limit set to the [default membership limit](/docs/guides/organizations/configure#membership-limits). This can be overridden on a per-organization basis.
25+
> - If an organization's seat limits are forcibly lowered (e.g., their subscription ending or their Plan being changed by an administrator), the organization will keep their currently provisioned seats but cannot invite new members until they're under the new seat limit.
26+
> - When an organization is on a seat-limited Plan, you cannot manually set the organization's seat limit.
27+
28+
## SDK version requirements
29+
30+
To use seat limits, you need to be using the following Clerk SDK versions:
31+
32+
- `@clerk/react` v6.1.4 or higher
33+
- `@clerk/nextjs` v7.0.8 or higher
34+
- `@clerk/expo` v3.1.6 or higher
35+
- `@clerk/react-router` v3.0.8 or higher
36+
- `@clerk/tanstack-react-start` v1.0.8 or higher
37+
38+
## Managing seat limits
39+
40+
### Organization invitations
41+
42+
When an organization subscribes to a Plan with seat limits, they'll be able to invite members to their organization up to the Plan's limit, as well as revoke invitations that were already sent out.
43+
44+
Once an organization reaches the seat limit, they will no longer be able to invite new members.
45+
46+
### Changing Plans
47+
48+
If an organization wants to switch to a Plan with a seat limit and the organization has more members than allowed by the Plan, they must remove members from their organization prior to switching Plans.
49+
50+
If an organization wants to switch from a seat-limited Plan to a Plan without seat limits and is currently over the default membership limit for organizations, they must remove members before switching Plans.

docs/manifest.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,10 @@
564564
"title": "Free trials",
565565
"href": "/docs/guides/billing/free-trials"
566566
},
567+
{
568+
"title": "Plans with seat limits",
569+
"href": "/docs/guides/billing/seat-limit-plans"
570+
},
567571
{
568572
"title": "Default Plans",
569573
"href": "/docs/guides/billing/default-plans"

0 commit comments

Comments
 (0)