Create Clerk billing price transition

Transition a billing subscription item from one price to another.

← All Clerk endpoints · Capability overview

POST/v1/clerk/billing/subscription-items/{subscription_item_id}/price-transitions

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

8 tokens

Transition a billing subscription item from one price to another.

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

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

from_price_idstringRequired

Current billing price id to transition from.

to_price_idstringRequired

Target billing price id to transition to.

Response14 fields

price_transitionobject

13 fields

Price transition result from Clerk.

objectstring

Clerk object type for the price transition response.

subscription_itemobject

11 fields

Updated subscription item after the price transition.

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}/price-transitions"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "subscription_item_id": "si_2abc123",
    "from_price_id": "price_2abc123",
    "to_price_id": "price_2xyz789"
}

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

Example responses1 example

200Subscription item after a price transition.

price_transition.json

{
  "price_transition": {
    "object": "billing.price_transition",
    "subscription_item": {
      "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
    }
  }
}