运营客户试用

POST/api/v1/subscriptions/trials/manage

可信服务端使用固定 requestId 和原因启动、延长或结束试用。免费与 Stripe 试用按各自来源验证；延长从当前请求时间计算。Apple／Google 返回 store_action_required 和商店管理入口，不伪造商店生效。

SDK 0.0.1更新于 2026年10月14日

发起请求

调用凭据: 仅服务端 API Key。由可信后端调用。
所需权限: billing:write

base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。

Web Beta 的结账需要明确配置 Stripe Sandbox 测试账号与已发布价格映射。跳转完成不等于支付确认。

request.shShell

1curl -X POST "$GROOVE_BASE_URL/api/v1/subscriptions/trials/manage" \2  -H "Authorization: Bearer $GROOVE_SECRET_KEY" \3  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \4  -H "X-Groove-Environment: sandbox" \5  -H "Content-Type: application/json" \6  -d '{7  "customerId": "00000000-0000-4000-8000-000000000001",8  "requestId": "00000000-0000-4000-8000-000000000001",9  "action": "extend",10  "membershipId": "00000000-0000-4000-8000-000000000001",11  "days": 14,12  "reason": "Customer support extension"13}'

响应选项卡列出字段类型，不是响应示例；实际值由客户状态决定。

请求参数

JSON 请求体

requestIduuid | uuid | uuid必填: 你的业务请求 UUID；同一次操作重试复用，新的操作生成新值。
reasonstring | string | string必填: 拒绝原因或账本操作说明；结合 accepted / 状态判断结果。
action"start" | "extend" | "end"必填: 本次业务动作。不同动作的目标字段和数量要求不同，见请求结构与示例。
productVersionIduuid可选: 本次操作的 productVersionId 值，类型和约束见字段标注。
entityIduuid可选: 当前客户范围内的实体 ID；只用于已配置的实体和许可功能。
daysinteger | integer可选: 本次操作的 days 值，类型和约束见字段标注。
customerIduuid | uuid | uuid必填: Indiana 客户 ID。服务端从已验证身份关联；客户 Token 调用时省略并使用 Token 绑定的客户。
membershipIduuid | uuid可选: 本次操作的 membershipId 值，类型和约束见字段标注。

响应字段

成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。

HTTP 200 · application/json

requestIduuid必填

服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。

scopeobject必填

响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。

展开子字段

projectIdstring必填

凭据绑定的 App ID。

minLength: 1

environmentenum必填

独立数据范围：sandbox 或 live。

查看允许值

"sandbox""live"

trialobject必填

本次操作的 trial 值，类型和约束见字段标注。

展开子字段

operationIduuid必填

业务操作 UUID；订阅执行引用 previewAttach 返回的 operationId，余额退款引用原消费操作。

statusenum必填

本次操作的 status 值，类型和约束见字段标注。

查看允许值

"effective""store_action_required"

providerenum必填

本次操作的 provider 值，类型和约束见字段标注。

查看允许值

"free""stripe""apple""google"

membershipIdsarray必填

本次操作的 membershipIds 值，类型和约束见字段标注。

minItems: 1 · maxItems: 20

endsAtdate-time | null必填

本次操作的 endsAt 值，类型和约束见字段标注。

managementUrluri | null必填

本次操作的 managementUrl 值，类型和约束见字段标注。

处理错误

常见失败
错误码	处理方式
UNAUTHENTICATED	核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN	核对当前 Key 权限与客户访问范围。
INVALID_REQUEST	检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH	使用凭据绑定的 App 和环境。

常见失败

UNAUTHENTICATED
处理方式
核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
处理方式
核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
处理方式
检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
处理方式
使用凭据绑定的 App 和环境。

相关:完整请求与错误约定·返回接口索引