Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.docs.onlydrams.app/llms.txt

Use this file to discover all available pages before exploring further.

​
URL Parameters

​
community_id
integer
required
The ID of the community

​
Query Parameters

​
status
string
Filter by status - active or archived

​
Returns

Returns an array of membership tier objects for the specified community. 
curl -X GET https://api.onlydrams.app/odis/v1/communities/1/tiers \
     -H "Authorization: Bearer $ACCESS_TOKEN" \
     -G \
     -d "status=active"

[
  {
    "id": 1,
    "name": "Bronze Member",
    "description": "Basic access to community content",
    "monthly_price_cents": 999,
    "monthly_price_dollars": 9.99,
    "annual_price_cents": 9990,
    "annual_price_dollars": 99.9,
    "annual_discount_percentage": 17,
    "annual_savings_cents": 2000,
    "annual_savings_dollars": 20.0,
    "currency": "usd",
    "free_trial_enabled": true,
    "free_trial_days": 7,
    "require_shipping_address": false,
    "member_limit": 100,
    "current_member_count": 45,
    "has_available_spots": true,
    "position": 1,
    "status": "active",
    "cover_image_url": "https://storage.googleapis.com/onlydrams/tiers/bronze.jpg",
    "stripe_product_id": "prod_xxx",
    "stripe_price_id": "price_xxx",
    "community": {
      "id": 1,
      "name": "Whisky Enthusiasts"
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-11-14T08:20:00Z"
  },
  {
    "id": 2,
    "name": "Gold Member",
    "description": "Premium access with exclusive content",
    "monthly_price_cents": 1999,
    "monthly_price_dollars": 19.99,
    "annual_price_cents": 19190,
    "annual_price_dollars": 191.9,
    "annual_discount_percentage": 20,
    "annual_savings_cents": 4798,
    "annual_savings_dollars": 47.98,
    "currency": "usd",
    "free_trial_enabled": true,
    "free_trial_days": 7,
    "require_shipping_address": true,
    "member_limit": 50,
    "current_member_count": 30,
    "has_available_spots": true,
    "position": 2,
    "status": "active",
    "cover_image_url": "https://storage.googleapis.com/onlydrams/tiers/gold.jpg",
    "stripe_product_id": "prod_yyy",
    "stripe_price_id": "price_yyy",
    "community": {
      "id": 1,
      "name": "Whisky Enthusiasts"
    },
    "created_at": "2024-01-15T11:00:00Z",
    "updated_at": "2024-11-14T09:15:00Z"
  }
]

​
Response Fields

​
id
integer
Unique identifier for the membership tier
​
name
string
Display name of the tier (max 100 characters)
​
description
string
Description of tier benefits (max 5000 characters)
​
monthly_price_cents
integer
Monthly subscription price in cents
​
monthly_price_dollars
float
Monthly subscription price in dollars
​
annual_price_cents
integer
Annual subscription price in cents (after discount)
​
annual_price_dollars
float
Annual subscription price in dollars (after discount)
​
annual_discount_percentage
integer
Discount percentage for annual billing (0-100)
​
annual_savings_cents
integer
Amount saved with annual billing vs monthly (in cents)
​
annual_savings_dollars
float
Amount saved with annual billing vs monthly (in dollars)
​
free_trial_enabled
boolean
Whether this tier offers a free trial period
​
free_trial_days
integer
Number of free trial days (default 7 if enabled)
​
require_shipping_address
boolean
Whether subscribers must provide a shipping address
​
member_limit
integer
Maximum number of members allowed (null for unlimited)
​
current_member_count
integer
Current number of active members in this tier
​
has_available_spots
boolean
Whether new subscriptions are available
​
position
integer
Sort order for displaying tiers
​
status
string
Tier status: active or archived