Skip to main content
GET
Get the organization's active trial number

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Response

The active trial-number assignment, or null when none is held.

The active trial-number assignment, or null when none is held.

data
null | object

The trial assignment, or null when the org holds no active trial.

meta
object

Standard response metadata. On the no-active-trial response (data: null) it also carries a human-readable message explaining why no trial is returned.