Subscriptions
Subscriptions

Get Detailed Subscription Status

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.

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

Response

Successful Response

plan_namestring required
plan_display_namestring required
statusstring required
scans_used_this_monthinteger required
scans_limitinteger nullable required
collection_countinteger required
billing_periodstring nullable
next_billing_datestring date-time nullable
cancel_at_period_endboolean
start_datestring date-time required
current_period_endstring date-time nullable

Changes

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