Get Subscription
Get team’s subscription details for both FREE and PRO tiers.
Required Role: VIEWER or higher
Returns comprehensive subscription information for any tier:
- FREE tier: Basic status with null subscription fields
- PRO tier: Full subscription details from local cache (updated via Polar webhooks)
Use this for displaying subscription status in settings/billing pages and dashboard widgets.
Documentation Index
Fetch the complete documentation index at: https://docs.dataraven.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Successful Response
Unified subscription response for both FREE and PRO tiers.
This schema handles both FREE tier teams (no subscription record) and PRO tier teams (with full subscription details).
For FREE tier:
- has_subscription: False
- subscription_tier: "free"
- All subscription-specific fields will be None
For PRO tier:
- has_subscription: True
- subscription_tier: "pro"
- All subscription fields populated
True if team has a subscription record
Subscription tier (free or pro)
True if PRO tier is currently active
Subscription UUID
Team UUID
Polar subscription status (active, canceled, unpaid, etc.)
Billing period start (ISO format)
Billing period end (ISO format)
If true, subscription will end at current_period_end
Cancellation timestamp (ISO format)
Subscription amount in dollars (e.g., 20.00)
Currency code (usd)
Polar subscription ID
Polar customer ID