Cancel Clerk billing subscription item

Cancel a billing subscription item in a connected Clerk application.

← All Clerk endpoints · Capability overview

POST/v1/clerk/billing/subscription-items/{subscription_item_id}/cancel

https://api.vee3.io/v1/clerk/billing/subscription-items/{subscription_item_id}/cancel

8 tokens

Cancel a billing subscription item 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.cancel_billing_subscription_item

Parameters3 fields

clerk_instance_idstringOptional

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

subscription_item_idstringRequired

Clerk billing subscription item id.

end_nowbooleanOptional

When true, end the subscription immediately instead of at period end.

Response12 fields

subscription_itemobject

11 fields

Canceled subscription item summary.

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/billing/subscription-items/{subscription_item_id}/cancel"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "subscription_item_id": "si_2abc123"
}

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

Example responses1 example

200Subscription item after cancellation.

canceled_subscription_item.json

{
  "subscription_item": {
    "id": "si_2abc123",
    "status": "canceled",
    "plan_id": "plan_2abc123",
    "price_id": "price_2abc123",
    "payer_id": "user_2abc123",
    "is_free_trial": false,
    "period_start": 1710000000000,
    "period_end": 1712592000000,
    "canceled_at": 1710000000000
  }
}