预览订阅明细退款
POST/api/v1/subscriptions/refunds/preview
可信服务端按已验证购买和发票行冻结退款金额及权益处理规则。报价尚未发起退款。
SDK 0.0.1更新于
发起请求
可信服务端按已验证购买和发票行冻结退款金额及权益处理规则。报价尚未发起退款。
- 调用凭据
- 仅服务端 API Key。由可信后端调用。
- 所需权限
billing:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
1curl -X POST "$GROOVE_BASE_URL/api/v1/subscriptions/refunds/preview" \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 "membershipId": "00000000-0000-4000-8000-000000000001",10 "purchaseId": "00000000-0000-4000-8000-000000000001",11 "lines": [12 {13 "invoiceLineId": "il_example",14 "amountMinor": 10015 }16 ],17 "entitlementAction": "retain"18}'
响应选项卡列出字段类型，不是响应示例；实际值由客户状态决定。
请求参数
JSON 请求体
requestIduuid必填你的业务请求 UUID；同一次操作重试复用，新的操作生成新值。
membershipIduuid必填本次操作的 membershipId 值，类型和约束见字段标注。
purchaseIduuid必填本次操作的 purchaseId 值，类型和约束见字段标注。
linesarray必填本次操作的 lines 值，类型和约束见字段标注。
minItems: 1 · maxItems: 20
展开子字段
invoiceLineIdstring必填本次操作的 invoiceLineId 值，类型和约束见字段标注。
pattern: ^il_[A-Za-z0-9_]+$
amountMinorinteger必填本次操作的 amountMinor 值，类型和约束见字段标注。
max: 100000000
entitlementActionenum必填本次操作的 entitlementAction 值，类型和约束见字段标注。
查看允许值
"retain""revoke"
customerIduuid必填Indiana 客户 ID。服务端从已验证身份关联；客户 Token 调用时省略并使用 Token 绑定的客户。
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围：sandbox 或 live。
查看允许值
"sandbox""live"
quoteobject必填本次操作的 quote 值，类型和约束见字段标注。
展开子字段
operationIduuid必填业务操作 UUID；订阅执行引用 previewAttach 返回的 operationId，余额退款引用原消费操作。
membershipIduuid必填本次操作的 membershipId 值，类型和约束见字段标注。
purchaseIduuid必填本次操作的 purchaseId 值，类型和约束见字段标注。
invoiceIdstarts_with必填本次操作的 invoiceId 值，类型和约束见字段标注。
currencyenum必填已发布价格支持的币种代码。
查看允许值
"USD""EUR""CNY""GBP""JPY""CAD""AUD""NZD""CHF""HKD""SGD""KRW""INR""BRL""MXN""TWD""THB""IDR""MYR""PHP""VND""ZAR""AED""SAR""SEK""NOK""DKK""PLN""CZK""HUF""ILS""TRY""RON"
amountMinorinteger必填本次操作的 amountMinor 值，类型和约束见字段标注。
max: 100000000
entitlementActionenum必填本次操作的 entitlementAction 值，类型和约束见字段标注。
查看允许值
"retain""revoke"
linesarray必填本次操作的 lines 值，类型和约束见字段标注。
minItems: 1 · maxItems: 20
展开子字段
invoiceLineIdstring必填本次操作的 invoiceLineId 值，类型和约束见字段标注。
pattern: ^il_[A-Za-z0-9_]+$
amountMinorinteger必填本次操作的 amountMinor 值，类型和约束见字段标注。
max: 100000000
expiresAtdate-time必填ISO 8601 UTC 到期时间；会话和预占到期后不能继续使用。
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key，或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引