Get Clerk user billing credit balance

Retrieve the billing credit balance for a Clerk user.

← All Clerk endpoints · Capability overview

GET/v1/clerk/users/{user_id}/billing/credit-balance

https://api.vee3.io/v1/clerk/users/{user_id}/billing/credit-balance

3 tokens

Retrieve the billing credit balance 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_credit_balance

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.

Response3 fields

credit_balanceobject

2 fields

User billing credit balance summary.

balance_amountinteger

Credit balance amount in cents.

currencystring

ISO currency code for the credit balance.

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/credit-balance"
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 credit balance for a Clerk user.

user_credit_balance.json

{
  "credit_balance": {
    "balance_amount": 5000,
    "currency": "usd"
  }
}