Adjust Clerk user billing credit balance

Increase or decrease billing credit for a Clerk user.

← All Clerk endpoints · Capability overview

POST/v1/clerk/users/{user_id}/billing/credit-balance/adjust

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

8 tokens

Increase or decrease billing credit 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.adjust_user_billing_credit_balance

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

amountintegerRequired

Credit adjustment amount in cents (minimum 1).

min 1

action"increase" | "decrease"Required

Credit adjustment action: "increase" or "decrease".

idempotency_keystringRequired

Unique key to make the credit adjustment idempotent.

currencystringOptional

ISO currency code for the credit adjustment.

notestringOptional

Optional note describing the credit adjustment.

Response9 fields

credit_ledgerobject

8 fields

Credit ledger entry created by the adjustment.

idstring

Clerk billing credit ledger entry id.

payer_idstring

Payer id (user_... or org_...) for the ledger entry.

source_typestring

Source type for the credit adjustment.

source_idstring

Source id for the credit adjustment.

notestring

Optional note describing the credit adjustment.

created_atstring

RFC3339 timestamp when the ledger entry was created.

amountinteger

Credit adjustment amount in cents.

currencystring

ISO currency code for the credit adjustment.

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/adjust"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123",
    "amount": 1000,
    "action": "ban",
    "idempotency_key": "idem_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Credit ledger entry after adjusting a user credit balance.

adjusted_user_credit_balance.json

{
  "credit_ledger": {
    "id": "cl_2abc123",
    "payer_id": "user_2abc123",
    "source_type": "manual_adjustment",
    "source_id": "adj_2abc123",
    "note": "Promotional credit",
    "created_at": "2024-03-10T12:00:00Z",
    "amount": 5000,
    "currency": "usd"
  }
}