Skip to main content
GET
Line Plan Limits
Call this before POST /api/line-requests to know whether a new line is included, needs payment, or is not allowed at all on the current plan.

Authentication

Pass your workspace API key as a Bearer token, or use a Clerk session token.

Example

Success (200 OK)

-1 means unlimited, not zero. Check for -1 before comparing a count against a limit.

Response

string | null
Plan id, e.g. starter. null when there is no active subscription.
string
Human-readable plan name.
object
Plan ceilings. effectiveMaxPhoneLines / effectiveMaxEmailLines already include purchased add-ons — compare against those, not the raw max.
object
Add-ons bought so far and how many more can still be bought.
object
phoneLines and emailLines the workspace has today.
boolean
Whether a phone line can be created right now.
boolean
Whether an email line can be created right now.
string
Only present when there is no active subscription: "No active subscription", with every limit 0 and both canCreate* flags false.

Errors