Skip to main content

Public API overview

The v1 public API exposes subscription lifecycle management, global reminder settings, spending analytics, and audit access through Developer API keys (Authorization: Bearer subm_…). It also powers SteadyRenew’s remote Streamable HTTP MCP endpoint (/api/mcp) and standalone local MCP server.

Base path

(For self-hosted deployments, replace https://steadyrenew.com with your own origin.) Main endpoint groups live under:

Design choices

  • API responses are JSON, and request/response field names use camelCase.
  • Database-managed fields (id, createdAt, updatedAt) are read-only.
  • Every query and mutation is scoped to the authenticated API key owner.
  • nextPaymentDate is the authoritative renewal date; monthly schedules preserve their original calendar-day anchor (billingAnchorDay).
  • Overdue active non-trial subscriptions automatically roll nextPaymentDate forward to the current billing cycle on read and in spend summaries (matching the web dashboard and Bark reminders). Free trials (isTrial: true) and paused / cancelled records do not auto-advance.
  • status is returned on records and accepted as a list filter, but is not writable through the public API.
  • Notification settings expose only enabled and daysBefore for writes; Bark URL, test push, timeZone, and locale stay web-managed.
  • Analytics endpoints report totals per currency and never convert across currencies. Duplicate detection and optimization candidates require Lifetime Premium (403 premium_required on Free).
  • Audit endpoints expose write history (subscription.create, subscription.update, subscription.delete) for public API operations.
  • Write operations return AI-readable validation errors (field, suggestedFix, allowedValues, writableFields) before consuming rate-limit quota.

AI & MCP artifacts

Use these endpoints and files when connecting an AI assistant, MCP host, or agent framework:

Default plan limits

Self-hosters can override defaults with server-only environment variables:

Endpoints

API reference

Open the API Reference tab in the top navigation bar (generated from openapi.yaml) for interactive request/response schemas and examples.