Clerk API (unofficial showcase)
POST/billing/subscription_items/{subscription_item_id}/price_transition

Create a price transition for a subscription item

Creates a price transition for the specified subscription item. This may create an upcoming subscription item or activate immediately depending on plan and payer rules.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
subscription_item_idstringrequired
The ID of the subscription item to transition

Parameters for the price transition

from_price_idstringrequired
The current price ID of the subscription item.
to_price_idstringrequired
The target price ID to transition to.

8 status codes
200A commerce price transition.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:commerce_price_transition
subscription_itemobjectrequired
transitionobjectrequired
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Authorization invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
409Conflict
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
500Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found. A 409 is returned: Conflict. A 422 is returned: Invalid request parameters. A 500 is returned: Request was not successful.