getApiV1SubscriptionsStatus

getApiV1SubscriptionsStatus<ThrowOnError>(options?: Options<GetApiV1SubscriptionsStatusData, ThrowOnError>): RequestResult<GetApiV1SubscriptionsStatusResponses, GetApiV1SubscriptionsStatusErrors, ThrowOnError>

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

Get subscription status

Returns the current subscription status, plan, and billing period info

Type Parameters

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

Parameters

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

Returns

RequestResult<GetApiV1SubscriptionsStatusResponses, GetApiV1SubscriptionsStatusErrors, ThrowOnError>