v1

latestOpenAPI 3.1.02026-07-1382141292.4 KB

Subscriptions

Adjust Subscription

Adjust an active subscription by changing its plan or quantity. Supports immediate adjustments with proration, end-of-billing-period adjustments for downgrades, and auto timing that automatically chooses based on whether it's an upgrade or downgrade. Also supports priceSlug for referencing prices by slug instead of id. For immediate adjustments with proration, this endpoint waits for the billing run to complete before returning, ensuring the subscription is fully updated.

post/api/v1/subscriptions/{id}/adjust

Path parameters

idstring required

Request body

Response

Successful response

resolvedTiming'immediately' | 'at_end_of_current_billing_period' required

The actual timing applied. When 'auto' timing is requested, this indicates whether the adjustment was applied immediately (for upgrades) or at the end of the billing period (for downgrades).

isUpgradeboolean required

Whether this adjustment is an upgrade (true) or downgrade/lateral move (false). An upgrade means the new plan total is greater than the old plan total.