跳到正文
Indiana
控制台
文档
章节目录 / 只读核对 Stripe 订阅

只读核对 Stripe 订阅

POST/api/v1/subscriptions/verify

可信服务端使用 billing:read 按 App、环境和客户核对已验证合同与当前 Stripe Sandbox 订阅。返回 consistent、drifted 或 incomplete 及逐项差异;不扣款、不修复、不刷新账本。缺少期间或明细证明不能视为一致。

SDK 0.0.1更新于

发起请求

可信服务端使用 billing:read 按 App、环境和客户核对已验证合同与当前 Stripe Sandbox 订阅。返回 consistent、drifted 或 incomplete 及逐项差异;不扣款、不修复、不刷新账本。缺少期间或明细证明不能视为一致。

调用凭据
仅服务端 API Key。由可信后端调用。
所需权限
billing:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值,不会执行请求。服务端 Key 不可放入浏览器。
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/subscriptions/verify" \  -H "Authorization: Bearer $GROOVE_SECRET_KEY" \  -H "X-Groove-Project: $GROOVE_PROJECT_ID" \  -H "X-Groove-Environment: sandbox" \  -H "Content-Type: application/json" \  -d '{  "customerId": "00000000-0000-4000-8000-000000000001"}'

响应为示例,不代表已实际执行请求。

请求参数

JSON 请求体

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"

verificationobject必填

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

展开子字段
customerIduuid必填

Indiana 客户 ID。服务端从已验证身份关联;客户 Token 调用时省略并使用 Token 绑定的客户。

provider"stripe"必填

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

checkedAtdate-time必填

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

statusenum必填

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

查看允许值

"consistent""drifted""incomplete"

checkedSubscriptionsinteger必填

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

min: 0 · max: 9007199254740991

differencesarray必填

已验证合同与提供商当前读数的逐字段差异。expected 是合同值,actual 是提供商值;缺少证明时不会报告一致。

maxItems: 10000

展开子字段
subscriptionIdstarts_with必填

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

itemIdstring | null必填

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

fieldenum必填

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

查看允许值

"subscription""status""currency""cancelAtPeriodEnd""item""price""product""quantity""periodStart""periodEnd""evidence"

expectedstring | number | boolean | null必填

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

actualstring | number | boolean | null必填

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

处理错误

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

常见失败

  • UNAUTHENTICATED

    处理方式
    核对 Key,或将过期客户 Token 重新签发一次。
  • FORBIDDEN

    处理方式
    核对当前 Key 权限与客户访问范围。
  • INVALID_REQUEST

    处理方式
    检查字段类型、UUID、十进制字符串和互斥字段。
  • SCOPE_MISMATCH

    处理方式
    使用凭据绑定的 App 和环境。

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