List Clerk billing plans

List billing plans in a connected Clerk application.

← All Clerk endpoints · Capability overview

GET/v1/clerk/billing/plans

https://api.vee3.io/v1/clerk/billing/plans

5 tokens

List billing plans in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.list_billing_plans

Parameters5 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

paginatedbooleanOptional

Whether to return paginated results with total_count.

limitintegerOptional

Maximum number of billing plans to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of billing plans to skip before returning results.

Default: 0 · min 0

payer_type"user" | "org"Optional

Filter by payer type: "user" or "org".

Response13 fields

billing_plansarrayitems

11 fields

Billing plans in the connected Clerk application.

idstring

Clerk billing plan id.

namestring

Billing plan display name.

slugstring

Billing plan slug.

descriptionstring

Billing plan description.

for_payer_typestring

Payer type the plan applies to ("user" or "org").

is_defaultboolean

Whether this is the default plan for its payer type.

is_recurringboolean

Whether the plan bills on a recurring schedule.

publicly_visibleboolean

Whether the plan is visible on public pricing pages.

has_base_feeboolean

Whether the plan includes a base fee.

free_trial_enabledboolean

Whether a free trial is enabled for the plan.

free_trial_daysinteger

Number of free trial days when free_trial_enabled is true.

total_countinteger

Total number of billing plans matching the query.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/billing/plans"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "paginated": False
}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Billing plans from a connected Clerk application.

billing_plan_list.json

{
  "billing_plans": [
    {
      "id": "plan_2abc123",
      "name": "Pro",
      "slug": "pro",
      "description": "Professional plan",
      "for_payer_type": "user",
      "is_default": false,
      "is_recurring": true,
      "publicly_visible": true,
      "has_base_fee": true,
      "free_trial_enabled": true,
      "free_trial_days": 14
    }
  ],
  "total_count": 1
}