Get Clerk user billing subscription

Retrieve the billing subscription for a Clerk user.

← All Clerk endpoints · Capability overview

GET/v1/clerk/users/{user_id}/billing/subscription

https://api.vee3.io/v1/clerk/users/{user_id}/billing/subscription

3 tokens

Retrieve the billing subscription for a Clerk user.

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.get_user_billing_subscription

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

Response21 fields

subscriptionobject

20 fields

User billing subscription summary.

idstring

Clerk billing subscription id.

statusstring

Subscription status.

payer_idstring

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

instance_idstring

Clerk instance id for the subscription.

active_atinteger

Unix timestamp in milliseconds when the subscription became active.

past_due_atinteger

Unix timestamp in milliseconds when the subscription became past due.

created_atinteger

Unix timestamp in milliseconds when the subscription was created.

updated_atinteger

Unix timestamp in milliseconds when the subscription was last updated.

subscription_itemsarrayitems

11 fields

Subscription items on this subscription.

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.

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/users/{user_id}/billing/subscription"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "user_id": "user_2abc123"
}

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

Example responses1 example

200Billing subscription for a Clerk user.

user_billing_subscription.json

{
  "subscription": {
    "id": "sub_2abc123",
    "status": "active",
    "payer_id": "user_2abc123",
    "instance_id": "ins_2abc123",
    "active_at": 1710000000000,
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "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
      }
    ]
  }
}