reseller
GET /v1/reseller/statements/{statementId}
One statement, with the line for every client.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 reseller.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/reseller/statements/{statementId} \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Each line snapshots the client, the plan, Zinn®'s list price, the discount that was applied and the result — so the charge stays explainable after the rate changes. Requires `reseller.view`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
statementId (path) | Uuid | 是 | — |
org_id (query) | Uuid | 否 | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | Uuid | 是 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
period_start | string | 是 | — |
period_end | string | 是 | — |
currency | string | 是 | — |
status | string<open, needs_review, issued, paid> | 是 | `needs_review` means at least one line could not be priced. It is the one state that must not become an invoice — an under-priced bill looks exactly like a correct one and nobod… |
subtotal_minor | integer | 是 | — |
unpriced_lines | integer | 是 | — |
line_count | integer | 是 | — |
invoice_id | Uuid | null | 否 | — |
generated_at | string | 是 | — |
lines | WholesaleStatementLine[] | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 429