跳到正文
Indiana
控制台
文档
章节目录 / 查询客户订阅

查询客户订阅

POST/api/v1/subscriptions/list

可信服务端按客户、Entity、商品、渠道和状态筛选，使用服务端游标分页。保留 Stripe、Apple、Google 和免费来源；同一客户的多个来源不会合并成虚构的单一合同。App 和环境来自已验证密钥。

SDK 0.0.1更新于

发起请求

可信服务端按客户、Entity、商品、渠道和状态筛选，使用服务端游标分页。保留 Stripe、Apple、Google 和免费来源；同一客户的多个来源不会合并成虚构的单一合同。App 和环境来自已验证密钥。

调用凭据
仅服务端 API Key。由可信后端调用。
所需权限
billing:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
request.shShell
curl -X POST "$GROOVE_BASE_URL/api/v1/subscriptions/list" \  -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",  "provider": "stripe",  "limit": 20}'

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

请求参数

JSON 请求体

customerIduuid可选

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

entityIduuid可选

当前客户范围内的实体 ID；只用于已配置的实体和许可功能。

productIduuid可选

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

providerenum可选

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

查看允许值

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

statusenum可选

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

查看允许值

"trial""active""past_due""ended""refunded"

cursorobject可选

上一页返回的不透明游标；不要修改或跨客户复用。

展开子字段
createdAtdate-time必填

记录创建时的 ISO 8601 UTC 时间。

iduuid必填

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

limitinteger可选

一页返回的最大记录数量，受契约上限限制。

min: 1 · max: 100

响应字段

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

HTTP 200 · application/json

requestIduuid必填

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

scopeobject必填

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

展开子字段
projectIdstring必填

凭据绑定的 App ID。

minLength: 1

environmentenum必填

独立数据范围：sandbox 或 live。

查看允许值

"sandbox""live"

subscriptionsobject必填

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

展开子字段
itemsarray必填

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

maxItems: 100

展开子字段
iduuid必填

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

customerIduuid必填

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

entityIduuid | null必填

当前客户范围内的实体 ID；只用于已配置的实体和许可功能。

productIduuid必填

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

productVersionIduuid必填

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

namestring必填

客户或对象的展示名称，不作为身份唯一键。

minLength: 1 · maxLength: 120

providerenum必填

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

查看允许值

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

createdAtdate-time必填

记录创建时的 ISO 8601 UTC 时间。

statusenum必填

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

查看允许值

"trial""active""past_due""ended"

cancelAtPeriodEndboolean必填

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

billingSubscriptionIduuid | null必填

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

nextCursorobject | null必填

下一页游标；null 表示结束。原样传回，改筛选条件时清空。

展开子字段
createdAtdate-time必填

记录创建时的 ISO 8601 UTC 时间。

iduuid必填

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

处理错误

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

常见失败

  • UNAUTHENTICATED

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

  • FORBIDDEN

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

  • INVALID_REQUEST

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

  • SCOPE_MISMATCH

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

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