Subscriptions/updateSubscription

Update a subscription

Planned

Planned. This contract is published ahead of the build. It is not callable yet — treat it as the shape to design against, not a live endpoint.

Change a subscription's price, quantity, or billing behavior.

PATCH/v1/subscriptions/{id}

Change the price or quantity. Proration is applied on the next invoice.

Path parameters

idstringRequired

Request body

application/json

priceIdstring

Example "price_pro_annual"

quantityinteger

Example 1

application/json

idstring

Example "sub_9c2a4f10"

customerIdstring

Example "cus_123"

priceIdstring

Example "price_pro_monthly"

statusenum

trialingactivepast_duecanceled

Example "active"

currentPeriodEndstring · ISO 8601

Example "2026-04-09T09:14:22Z"

cancelAtPeriodEndboolean

Example false

createdAtstring · ISO 8601

Example "2026-04-09T09:14:22Z"

updateSubscription