---
title: "Get Detailed Subscription Status"
method: GET
path: "/api/v1/subscriptions/status/detailed"
tags: ["Subscriptions", "Subscriptions"]
---

# Get Detailed Subscription Status

`GET /api/v1/subscriptions/status/detailed`

## Request

- Base URL: `https://api.gemstoneaiapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemstoneaiapp.com/api/v1/subscriptions/status/detailed`
- Auth: HTTP bearer

Get detailed subscription status including all limits and usage.

Returns comprehensive information about:
- Current plan and status
- Scan usage and limits
- Collection count and limits
- Billing information
- Next billing date

This is the recommended endpoint for displaying user subscription status in the app.

## Response `200`

Successful Response

- SubscriptionStatusDetailedResponse: Detailed subscription status including limits and usage
  - `plan_name` string, required
  - `plan_display_name` string, required
  - `status` string, required
  - `scans_used_this_month` integer, required
  - `scans_remaining` union, required
    - string
    - integer
  - `scans_limit` integer, nullable, required
  - `collection_count` integer, required
  - `collection_limit` union, required
    - string
    - integer
  - `billing_period` string, nullable
  - `next_billing_date` string, date-time, nullable
  - `cancel_at_period_end` boolean
  - `start_date` string, date-time, required
  - `current_period_end` string, date-time, nullable
  - `scan_tier` ScanTierQuota: Monthly allowance of a capped paid tier (LNK-SCANTIERS). Null on free plans and on unlimited (pre-tier) Premium.
    - `tier` string, required
    - `scans_used` integer, required
    - `scans_limit` integer, required
    - `scans_remaining` integer, required
    - `resets_at` string, required
    - `upgrade_tier` string, nullable

---

[API](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api.md) · [All operations](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/revisions/fcb441f55161?raw)