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.

Archives a membership tier to prevent new subscriptions while maintaining existing members.

​
URL Parameters

​
id
integer
required
The ID of the membership tier to archive

​
Returns

Returns the updated membership tier object with archived status. 
curl -X POST https://api.onlydrams.app/odis/v1/tiers/2/archive \
     -H "Authorization: Bearer $ACCESS_TOKEN"

{
  "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,
  "currency": "usd",
  "free_trial_enabled": true,
  "free_trial_days": 7,
  "require_shipping_address": true,
  "member_limit": 50,
  "current_member_count": 30,
  "has_available_spots": false,
  "position": 2,
  "status": "archived",
  "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-11-14T10:30:00Z",
  "updated_at": "2024-11-14T12:00:00Z"
}

​
Notes

  • Authorization: Community owner or admin only
  • Existing Members: Archived tiers maintain existing member subscriptions
  • New Subscriptions: Prevented for archived tiers
  • Stripe: Associated Stripe Product is marked as inactive
  • Reversible: Use the activate endpoint to reactivate