跳转到主要内容

开放 API 概览

v1 开放 API 通过 Developer API Key(Authorization: Bearer subm_…)提供订阅生命周期管理、全局提醒设置、支出分析和审计日志能力,同时驱动 SteadyRenew 的远程 Streamable HTTP MCP 端点(/api/mcp)与本地单文件 MCP 服务。

Base path

(自托管部署请将 https://steadyrenew.com 替换为你的站点域名。) 主要接口组位于:

设计约定

  • API 响应为 JSON,请求与响应字段统一使用 camelCase。
  • 数据库管理字段(id、createdAt、updatedAt)为只读。
  • 所有查询和变更都严格限定在当前 API Key 所属用户范围内。
  • nextPaymentDate 是权威续费日期;月付计划通过 billingAnchorDay 保留每月固定扣款日。
  • 已过期的 active 非试用订阅在读取和支出汇总中会自动将 nextPaymentDate 滚动到当前计费周期(与网页仪表盘及 Bark 提醒保持一致);免费试用(isTrial: true)以及 paused / cancelled 记录不会自动顺延。
  • status 会在记录中返回,也可作为列表过滤参数,但不能通过公开 API 写入。
  • 通知设置仅开放 enabled 与 daysBefore 的写入;Bark URL、测试推送、timeZone 和 locale 仍由网页端管理。
  • 分析端点按币种分别统计金额,不做跨币种换算。重复检测与优化建议需要终身高级版(Free 账户返回 403 premium_required)。
  • 审计端点暴露开放 API subscription.create、subscription.update 和 subscription.delete 的写操作历史。
  • 写操作在扣减限流配额前校验请求体,并返回带 field、suggestedFix、allowedValues、writableFields 的 AI 友好恢复提示。

AI 与 MCP 交付物

接入 AI 助手、MCP 客户端或 Agent 框架时,优先使用以下端点与文件:

默认套餐限额

自托管部署可通过服务端环境变量覆盖默认值:

Endpoints

API 参考

在顶部导航栏切换到 API 参考 标签页(由 openapi.yaml 自动生成),即可查看完整的请求参数与响应示例。