Skip to main content
GET
Check trial eligibility

Authorizations

Authorization
string
header
required

Enter your JWT in the format: Bearer {token}

Path Parameters

workspaceId
string
required

The ID of the workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

billingAccountId
string
required

The ID of the billing account, which corresponds to a Stripe Customer ID (cus_...).

Example:

"cus_a1b2c3d4e5f6g7h8"

Response

Trial eligibility status.

trial_eligible
boolean

Whether the workspace qualifies for a new trial subscription.

Example:

true

has_payment_method
boolean

Whether the billing account has a default payment method on file.

Example:

false

can_create_subscription
boolean

A convenient flag indicating if a new subscription can be created (either trial eligible or has a payment method).

Example:

true

trial_info
object
requirements
object

An object detailing what is needed to create a subscription if can_create_subscription is false.

Example: