Skip to main content
GET
/
workspaces
/
{workspaceId}
/
billing-accounts
/
{billingAccountId}
/
trial-eligibility
Check trial eligibility
curl --request GET \
  --url https://api.altostrat.io/workspaces/{workspaceId}/billing-accounts/{billingAccountId}/trial-eligibility \
  --header 'Authorization: Bearer <token>'
{
  "trial_eligible": true,
  "has_payment_method": false,
  "can_create_subscription": true,
  "trial_info": {
    "trial_days": 14,
    "message": "This workspace qualifies for a 14-day free trial because it has only one billing account with no existing subscriptions."
  },
  "requirements": {
    "add_payment_method": "A default payment method must be added before creating subscriptions."
  }
}

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:
{
  "add_payment_method": "A default payment method must be added before creating subscriptions."
}