Side Space

API reference

billing

Plans and quotas. The spaces a user owns count against their plan (storage, largest file, members per space, AI runs and minutes of audio and video per calendar month, UTC). A refused request answers 402 with code quota_exceeded and a message that says which limit and when it renews. Answers from the AI cache are free.

2 endpoints · Overview

GET/v1/me/plan

My plan, its limits after any overrides, and what I used this month
Bearer token

Responses

Example request
curl "https://side.example.com/v1/me/plan" \
  -H "Authorization: Bearer $SIDESPACE_TOKEN"
Example response · 200
{
  "user_id": "usr_01JD7Q1Z3X5V7T9R1P3N5L7J9H",
  "plan": {
    "id": "id",
    "name": "A001_C003.mov",
    "description": "description",
    "price_cents": 1,
    "price_yearly_cents": 1,
    "per_member": false,
    "currency": "currency",
    "public": false,
    "sort": 1,
    "updated_at": "2026-11-14T09:30:00Z"
  },
  "status": "default",
  "ends_at": "2026-11-14T09:30:00Z",
  "seats": 1,
  "overrides": {
    "storage_bytes": 1,
    "ai_runs_month": 1,
    "ai_media_minutes_month": 1,
    "members_per_space": 1,
    "max_file_bytes": 1
  },
  "limits": {
    "storage_bytes": 1,
    "ai_runs_month": 1,
    "ai_media_minutes_month": 1,
    "members_per_space": 1,
    "max_file_bytes": 1
  },
  "usage": {
    "stored_bytes": 1,
    "stored_measured_at": "2026-11-14T09:30:00Z",
    "ai_runs": 1,
    "ai_media_minutes": 0.5,
    "period_start": "2026-11-14T09:30:00Z",
    "period_end": "2026-11-14T09:30:00Z"
  },
  "over": [
    "storage"
  ],
  "provider": "provider"
}

GET/v1/plans

The server's public plans (no auth)
No auth

Responses

  • 200
    Plans
    object
    › Show fields
    • itemsPlan[]
      › 15 fields
      • storage_bytesinteger | null
        Bytes the owner's spaces may keep (each content counted once; spaces in their own bucket are not counted)
        required
      • ai_runs_monthinteger | null
        required
      • ai_media_minutes_monthinteger | null
        Minutes of audio and video that AI runs may read a month
        required
      • members_per_spaceinteger | null
        required
      • max_file_bytesinteger | null
        required
      • idstringrequired
      • namestringrequired
      • descriptionstring
      • price_centsintegerrequired
        Per month (per member when per_member)
      • price_yearly_centsinteger
        Per month when billed yearly (per member when per_member); 0: no yearly price
      • per_memberboolean
        The price, storage and AI allowances are per member; the account's limits are the plan's times its seats
      • currencystringrequired
      • publicbooleanrequired
      • sortinteger
      • updated_atTimestamp
Example request
curl "https://side.example.com/v1/plans"
Example response · 200
{
  "items": [
    {
      "id": "id",
      "name": "A001_C003.mov",
      "description": "description",
      "price_cents": 1,
      "price_yearly_cents": 1,
      "per_member": false,
      "currency": "currency",
      "public": false,
      "sort": 1,
      "updated_at": "2026-11-14T09:30:00Z"
    }
  ]
}