List Clerk billing subscription items

List billing subscription items in a connected Clerk application.

← All Clerk endpoints · Capability overview

GET/v1/clerk/billing/subscription-items

https://api.vee3.io/v1/clerk/billing/subscription-items

5 tokens

List billing subscription items 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_subscription_items

Parameters9 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 subscription items to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of subscription items to skip before returning results.

Default: 0 · min 0

statusstringOptional

Filter by subscription item status.

payer_type"user" | "org"Optional

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

plan_idstringOptional

Filter by billing plan id.

include_freebooleanOptional

When true, include free subscription items.

querystringOptional

Search query to filter subscription items.

Response13 fields

subscription_itemsarrayitems

11 fields

Billing subscription items matching the query.

idstring

Clerk billing subscription item id.

statusstring

Subscription item status.

plan_idstring

Billing plan id for the subscription item.

price_idstring

Billing price id for the subscription item.

payer_idstring

Payer id (user_... or org_...) for the subscription item.

is_free_trialboolean

Whether the subscription item is in a free trial.

period_startinteger

Unix timestamp in milliseconds when the current billing period started.

period_endinteger

Unix timestamp in milliseconds when the current billing period ends.

canceled_atinteger

Unix timestamp in milliseconds when cancellation was requested.

ended_atinteger

Unix timestamp in milliseconds when the subscription item ended.

past_due_atinteger

Unix timestamp in milliseconds when the subscription item became past due.

total_countinteger

Total number of subscription items 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/subscription-items"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

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

Example responses1 example

200Billing subscription items from a connected Clerk application.

subscription_item_list.json

{
  "subscription_items": [
    {
      "id": "si_2abc123",
      "status": "active",
      "plan_id": "plan_2abc123",
      "price_id": "price_2abc123",
      "payer_id": "user_2abc123",
      "is_free_trial": false,
      "period_start": 1710000000000,
      "period_end": 1712592000000
    }
  ],
  "total_count": 1
}