postApiV1SubscriptionsScheduleDowngrade

postApiV1SubscriptionsScheduleDowngrade<ThrowOnError>(options: Options<PostApiV1SubscriptionsScheduleDowngradeData, ThrowOnError>): RequestResult<PostApiV1SubscriptionsScheduleDowngradeResponses, PostApiV1SubscriptionsScheduleDowngradeErrors, ThrowOnError>

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

Schedule subscription downgrade

Schedules a plan downgrade (tier or interval) to take effect at the end of the current billing period using Stripe Subscription Schedules.

Type Parameters

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

Parameters

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

Returns

RequestResult<PostApiV1SubscriptionsScheduleDowngradeResponses, PostApiV1SubscriptionsScheduleDowngradeErrors, ThrowOnError>