Subscription Status

Retrieve the current subscription plan, status, and quota usage for the authenticated user.

https://api.cyborux.com

GET/api/stripe/subscription-status

Bearer

Authorizationheader

Bearer <token>

API key authentication — use your Cyborux API key as a Bearer token.

Response

{
  "user_type": "protect",
  "billing_interval": "monthly",
  "has_subscription": true,
  "subscription_status": "active",
  "current_period_end": "2026-04-10T00:00:00Z",
  "one_shot_credits": {
    "analyses": 2,
    "reports": 0,
    "deep_scans": 5
  },
  "usage": {
    "analyses_used": 3,
    "reports_used": 2,
    "deep_scans_used": 7
  }
}

Status	Detail
`401`	Not authenticated.
`503`	Stripe not configured — the billing integration is not set up in this environment.

{
  "detail": "Not authenticated."
}

Response Fields

user_typestring

Current plan tier: basic, protect, vigilant, enterprise.

billing_intervalstring | null

Billing cycle: monthly, yearly, or null for no subscription.

has_subscriptionboolean

Whether the user has an active paid subscription.

subscription_statusstring | null

Stripe subscription status. See values below.

current_period_endstring | null

ISO 8601 timestamp when the current billing period ends.

one_shot_creditsobject

Remaining one-shot credits not tied to the subscription quota.

usageobject

How many of each resource the user has consumed in the current period.

`subscription_status` Values

Value	Description
`active`	Subscription is current and in good standing.
`trialing`	Subscription is in a free trial period.
`past_due`	Payment failed — subscription features are still active but at risk.
`canceled`	Subscription has been cancelled.
`disputed`	A dispute has been opened on a charge.
`null`	No subscription exists (basic tier or one-shot only user).

curl -X GET https://api.cyborux.com/api/stripe/subscription-status \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch(
  "https://api.cyborux.com/api/stripe/subscription-status",
  { headers: { "Authorization": "Bearer YOUR_API_KEY" } }
);
const data = await res.json();

import requests

response = requests.get(
    "https://api.cyborux.com/api/stripe/subscription-status",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = response.json()

Response

Response Fields

subscription_status Values

`subscription_status` Values