Skip to main content

GetSubscriptionStatus returns a simplified subscription status view.

GET 
/api/v1/billing/subscription/status

Provides a lightweight status check suitable for all organization members to verify service access. Returns current status, plan name, limits vs usage, and days remaining in the current period.

Authorization​

Available to all authenticated organization members (no special permission). Useful for displaying status indicators in the application header/sidebar.

Use Cases​

  • Show "Trial: 7 days remaining" banner
  • Display usage meters (3/10 agents used)
  • Indicate subscription problems (past_due status)
  • Quick plan tier check for feature gating

Response​

Returns simplified status with:

  • is_active: true if service should be accessible
  • is_trial: true if in trial period
  • limits: map of resource limits from plan
  • usage: map of current resource usage
  • days_remaining: until renewal or trial end

Errors​

  • NOT_FOUND: Organization has no subscription
  • UNAUTHENTICATED: Missing or invalid authentication token

Responses​

A successful response.