postApiV1SubscriptionsCreateCheckoutSession

postApiV1SubscriptionsCreateCheckoutSession<ThrowOnError>(options: Options<PostApiV1SubscriptionsCreateCheckoutSessionData, ThrowOnError>): RequestResult<PostApiV1SubscriptionsCreateCheckoutSessionResponses, PostApiV1SubscriptionsCreateCheckoutSessionErrors, ThrowOnError>

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

Create checkout session

Creates a Stripe Checkout Session for a subscription plan and returns the checkout URL. Identify the plan with either price_id directly, or tier (“starter”/“pro”) + interval (“month”/“year”).

Type Parameters

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

Parameters

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

Returns

RequestResult<PostApiV1SubscriptionsCreateCheckoutSessionResponses, PostApiV1SubscriptionsCreateCheckoutSessionErrors, ThrowOnError>