Subscriptions
Subscriptions

Get User Plan Details

📋 COMPLETE PLAN DETAILS - Use this for detailed displays

Get full plan information including:

  • All plan features (categorized)
  • Usage statistics
  • Billing information
  • Plan metadata

Perfect for:

  • Account/Settings page
  • Plan comparison modals
  • Upgrade prompts with feature lists
  • Subscription management page

Response includes:

  • Full plan details with all features
  • Usage stats (scans used, gems count)
  • Billing info (price, next billing date)
  • All plan features categorized (Scanning, Analysis, Collection, etc.)

Example Usage:

// Call when user opens settings or subscription page
const details = await fetch('/api/v1/subscriptions/plan-details', {
  headers: { 'Authorization': `Bearer ${token}` }
}).then(r => r.json());

// Display full plan info
console.log(details.plan_display_name); // "Free" or "Premium"
console.log(details.features); // All categorized features
console.log(details.price); // "$29.99/monthly"

More Complete - Returns all plan information for detailed displays.

get/api/v1/subscriptions/plan-details

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/plan-details
  • Auth: HTTP bearer

Response

Successful Response

plan_idinteger required
plan_namestring required

Internal name: 'free' or 'premium'

plan_display_namestring required

Display name: 'Free' or 'Premium'

descriptionstring nullable

Plan description

is_activeboolean required

Is subscription currently active?

statusstring required

active, cancelled, expired, past_due

scans_used_this_monthinteger required
scans_limitinteger nullable required
collection_countinteger required
collection_limitinteger nullable required
featuresobject nullable

Categorized features: {category: [{feature, value}]}

billing_periodstring nullable
pricestring nullable
next_billing_datestring date-time nullable
cancel_at_period_endboolean
subscription_start_datestring date-time nullable
current_period_endstring date-time nullable

Example response

{
  "collection_count": 7,
  "collection_limit": 10,
  "collection_slots_remaining": 3,
  "description": "Perfect for getting started",
  "features": {
    "Scanning": [
      {
        "feature": "Monthly Scans",
        "value": "5 scans"
      }
    ]
  },
  "is_active": true,
  "plan_display_name": "Free",
  "plan_id": 1,
  "plan_name": "free",
  "scans_limit": 5,
  "scans_remaining": 3,
  "scans_used_this_month": 2,
  "status": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.