Skip to main content
GET
获取项目使用情况

概述

返回项目在当前信用周期内的信用消费全貌,包括剩余信用、订阅计划详情及按服务类型(RPC、DAS、gRPC、WebSocket等)的请求分解。 所有信用数据都限定于 creditCycle——信用累积和重置的窗口,源自订阅的账单锚点。每个项目都有,包括免费计划。 subscriptionDetails.billingCycle 是开票窗口;仅用于信息,并且 null 对于从不开票的免费计划。

请求参数

string
必填
要检索其使用情况的项目ID。必须与用于认证的API密钥关联的项目匹配。

响应字段

number
当前信用周期内剩余的信用。计算为计划的信用限制减去消耗的常规信用,最低为零。
number
当前信用周期内消耗的总信用,包括常规和预付信用。
number
仍然可用的预付信用。
number
当前信用周期内消耗的预付信用。
object
该响应中的所有信用数据所限定的窗口——信用累积和重置的周期,源自订阅的账单锚点。始终存在,适用于每个计划,包括免费计划。
string
信用周期的开始日期,格式为 YYYY-MM-DD(UTC)。
string
信用周期的结束日期,格式为 YYYY-MM-DD(UTC)。
object
订阅计划和开票周期信息。
object | null
当前开票周期的开始和结束日期。仅用于信息——对于从不开票的免费计划是 null。在付费计划中,这通常与 creditCycle 匹配。
string
开票周期开始日期,格式为 YYYY-MM-DD
string
开票周期结束日期,格式为 YYYY-MM-DD
number
根据您的计划,信用周期的总信用限额。
string
订阅计划的名称(例如,"business""professional")。
object
当前信用周期内每个产品的信用消费,以整额度计算。覆盖每个产品。值是累计的原始数值,最后进行四舍五入以匹配账单,因此每个产品的信用总和可能不完全等于 creditsUsed
number
标准Solana RPC消耗的信用。
number
增强API(例如,解析的交易、代币元数据)消耗的信用。
number
Wallet API消耗的信用。
number
DAS(数字资产标准)API消耗的信用。
number
Webhooks消耗的信用。
number
LaserStream gRPC消耗的信用(按带宽计费)。
number
LaserStream WebSocket消耗的信用(按带宽计费)。
number
预确认消耗的信用。
number
Archival消耗的信用。
number
Photon(ZK Compression)消耗的信用。
number
未分类使用消耗的信用。
object
当前信用周期内请求计数,仅适用于按请求计费的产品。按带宽计费的LaserStream产品(laserstreamGrpclaserstreamWebsocket)不会出现在此处——请参阅 dataTransfer。字段:rpcenhancedApiwalletApidaswebhookspreConfirmationsarchivalphotonother
object
当前信用周期内传输的字节数,仅适用于按带宽计费的LaserStream产品。这些产品按数据传输计费,而非请求计数,因此它们出现在此处及 credits 中,但从不在 requests 中。字段:laserstreamGrpclaserstreamWebsocket

请求参数

string
必填
要检索其使用情况的项目ID。必须与API密钥关联的项目匹配。

授权

api-key
string
query
必填

作为查询参数传递的API密钥。

路径参数

id
string<uuid>
必填

要检索使用情况的项目 ID。必须与 API 密钥关联的项目匹配。

示例:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

响应

成功检索项目使用情况。

creditsRemaining
number

当前信用周期内剩余的积分数量。计算公式为 creditsLimit - regularCreditsUsed,并且向下取整为 0。

示例:

487500

creditsUsed
number

当前信用周期内消耗的总积分,包括常规积分和预付积分。

示例:

12500

prepaidCreditsRemaining
number

剩余的预付信用额度。

示例:

50000

prepaidCreditsUsed
number

当前信用周期内消耗的预付积分数量。

示例:

0

creditCycle
object

此响应中每个信用数据的范围窗口——积分累积和重置的期间,从订阅的计费锚点派生而来。对于每个计划,包括从未开具发票的免费计划,它始终存在。

subscriptionDetails
object

项目的订阅计划和计费周期的详细信息。

credits
object

当前信用周期内每个产品的积分消耗,以完整积分为单位。涵盖每一个产品。值为累计原始数据,并在最后四舍五入以匹配计费,因此每个产品的积分可能在四舍五入后不会精确相加等于 creditsUsed

requests
object

当前信用周期内的请求计数,仅适用于请求计量的产品。带宽计量的 LaserStream 产品(laserstreamGrpclaserstreamWebsocket)不出现在此处——请参见 dataTransfer

dataTransfer
object

当前信用周期内的传输字节,仅适用于带宽计量的 LaserStream 产品。这些产品按照传输的数据量计费,不按请求计数,因此它们出现在此处和 credits 中,但从不出现在 requests 中。