postApiV1SubscriptionsCancel

postApiV1SubscriptionsCancel<ThrowOnError>(options?: Options<PostApiV1SubscriptionsCancelData, ThrowOnError>): RequestResult<PostApiV1SubscriptionsCancelResponses, PostApiV1SubscriptionsCancelErrors, ThrowOnError>

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

Cancel subscription

Cancels the user’s subscription at the end of the current billing period (cancel_at_period_end)

Type Parameters

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

Parameters

Parameter	Type
`options?`	`Options`<`PostApiV1SubscriptionsCancelData`, `ThrowOnError`>

Returns

RequestResult<PostApiV1SubscriptionsCancelResponses, PostApiV1SubscriptionsCancelErrors, ThrowOnError>