Skip to main content
GET
/
api
/
partner
/
v1
/
subscription
curl --request GET \
  --url https://www.genviral.io/api/partner/v1/subscription \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "code": 200,
  "message": "Subscription retrieved",
  "data": {
    "scope": "workspace",
    "workspace_id": "4cb5d3fd-8c8f-4ed7-a17c-4ffb52c7e6ac",
    "subscription": {
      "status": "active",
      "tier": "small",
      "billing_interval": "month",
      "current_period_start": "2026-02-01T00:00:00.000Z",
      "current_period_end": "2026-03-01T00:00:00.000Z",
      "renews_at": "2026-03-01T00:00:00.000Z",
      "canceled_at": null,
      "is_paused": false,
      "paused_until": null,
      "credits": {
        "limit": 500,
        "used_this_period": 123,
        "remaining": 377,
        "reset_at": "2026-03-01T00:00:00.000Z"
      }
    }
  }
}
Returns the core subscription attached to the authenticated key owner (workspace owner for workspace keys, owner user for personal keys). Use this endpoint to show customers:
  • current tier and subscription status
  • credits limit, credits used, and credits remaining
  • next renewal period end (renews_at) and credits reset date

​
Response

​
scope
string
Authenticated key scope: workspace or personal.
​
workspace_id
string | null
Workspace ID for workspace keys, otherwise null.
​
subscription
object
Active core subscription details.
curl --request GET \
  --url https://www.genviral.io/api/partner/v1/subscription \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "code": 200,
  "message": "Subscription retrieved",
  "data": {
    "scope": "workspace",
    "workspace_id": "4cb5d3fd-8c8f-4ed7-a17c-4ffb52c7e6ac",
    "subscription": {
      "status": "active",
      "tier": "small",
      "billing_interval": "month",
      "current_period_start": "2026-02-01T00:00:00.000Z",
      "current_period_end": "2026-03-01T00:00:00.000Z",
      "renews_at": "2026-03-01T00:00:00.000Z",
      "canceled_at": null,
      "is_paused": false,
      "paused_until": null,
      "credits": {
        "limit": 500,
        "used_this_period": 123,
        "remaining": 377,
        "reset_at": "2026-03-01T00:00:00.000Z"
      }
    }
  }
}

​
Error Responses

  • 401 — authentication failed (missing/invalid/revoked token)
  • 402 subscription_required — active Creator/Professional/Business plan required
  • 403 tier_not_allowed — Scheduler tier cannot use Partner API
  • 500 subscription_lookup_failed — unexpected subscription lookup failure