Platform

Subscription & Plans

Check subscription status, plan limits, available features, and manage Enterprise trials.

Subscription Status

GET/v1/user/subscription-status

Returns your current subscription tier, plan limits, feature flags, and usage counts. For organization-scoped status, use the org endpoint.

Related Endpoints

GET /v1/organizations/:org_id/subscription-statusendpoint

Organization subscription status

cURL

curl https://api.metriqual.com/v1/user/subscription-status \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

# Organization-scoped
curl https://api.metriqual.com/v1/organizations/org_abc123/subscription-status \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

TypeScript SDK

const status = await mql.subscription.getStatus();
console.log('Tier:', status.tier);
console.log('Limits:', status.limits);
console.log('Features:', status.features);

// Check a specific feature
const canUsePromptHub = await mql.subscription.hasFeature('prompt_hub');

Python SDK

status = client.subscription.get_status()
tier = client.subscription.get_plan_tier()
limits = client.subscription.get_limits()
features = client.subscription.get_features()

# Check a specific feature
has_prompts = client.subscription.has_feature("prompt_hub")

# Org-scoped
org_status = client.subscription.get_status(org_id="org_abc123")

CLI

# Check subscription status
mql subscription status

# Org-scoped
mql subscription status --org org_abc123

# View plan limits
mql subscription limits

200

{
  "tier": "pro",
  "plan_tier": "pro",
  "limits": {
    "proxy_keys": 25,
    "prompts": 100,
    "organizations": 5,
    "members_per_org": 20,
    "filters": 50
  },
  "features": {
    "prompt_hub": true,
    "analytics": true,
    "content_filters": true,
    "organizations": true,
    "custom_models": false
  },
  "usage": {
    "proxy_keys": 3,
    "prompts": 12,
    "organizations": 1
  }
}

Enterprise Trial

POST/v1/user/company-info

Start a 14-day Enterprise trial to unlock all features. Requires company information to activate.

Body Parameters

company_namestringrequired

Your company name

company_sizestring

Company size range (e.g., "1-10", "11-50", "51-200")

phone_numberstring

Contact phone number

Related Endpoints

GET /v1/user/trial/statusendpoint

Check trial status & remaining days

POST /v1/organizations/:org_id/company-infoendpoint

Start trial for an organization

Python SDK

# Check if you can start a trial
can_start = client.subscription.can_start_trial()

# Start a trial
result = client.subscription.start_trial(
    company_name="Acme Inc",
    company_size="11-50",
)

# Check trial status
trial = client.subscription.get_trial_status()
print(f"Trial active: {trial.get('active')}")

CLI

# Check trial status
mql subscription trial status

# Start 14-day Enterprise trial
mql subscription trial start

# Org-scoped trial
mql subscription trial start --org org_abc123

SDK Reference

TypeScript: mql.subscription.getStatus(), mql.subscription.getPlanTier(), mql.subscription.hasFeature()

Python: client.subscription.get_status(), client.subscription.get_plan_tier(), client.subscription.start_trial()

CLI: mql subscription status, mql subscription limits, mql subscription trial start