postApiV1SubscriptionsUpgrade

postApiV1SubscriptionsUpgrade<ThrowOnError>(options: Options<PostApiV1SubscriptionsUpgradeData, ThrowOnError>): RequestResult<PostApiV1SubscriptionsUpgradeResponses, PostApiV1SubscriptionsUpgradeErrors, ThrowOnError>

Defined in: src/client/sdk.gen.ts:778

Upgrade subscription

Upgrades the current subscription to a higher tier or from monthly to annual billing by modifying the existing Stripe subscription in-place. No extra credits are allocated for the current month; the new plan’s credit amount starts at the next billing cycle.

Type Parameters

Type Parameter	Default type
`ThrowOnError` extends `boolean`	`false`

Parameters

Parameter	Type
`options`	`Options`<`PostApiV1SubscriptionsUpgradeData`, `ThrowOnError`>

Returns

RequestResult<PostApiV1SubscriptionsUpgradeResponses, PostApiV1SubscriptionsUpgradeErrors, ThrowOnError>