Skip to main content
GET
Get Project Usage

Overview

Returns a complete picture of a project’s credit consumption for the current credit cycle, including credits remaining, subscription plan details, and a breakdown of requests by service type (RPC, DAS, gRPC, WebSocket, etc.). All credit figures are scoped to the creditCycle — the window credits accrue and reset against, derived from the subscription’s billing anchor. Every project has one, including free plans. The subscriptionDetails.billingCycle is the invoicing window; it is informational and null on free plans, which are never invoiced.

Request Parameters

string
required
The project ID to retrieve usage for. Must match the project associated with the API key used for authentication.

Response Fields

number
Credits remaining in the current credit cycle. Calculated as the plan’s credit limit minus regular credits consumed, floored at zero.
number
Total credits consumed in the current credit cycle, including both regular and prepaid credits.
number
Prepaid credits still available.
number
Prepaid credits consumed in the current credit cycle.
object
The window every credit figure in this response is scoped to — the period credits accrue and reset against, derived from the subscription’s billing anchor. Always present, for every plan, including free plans.
string
Credit cycle start date in YYYY-MM-DD format (UTC).
string
Credit cycle end date in YYYY-MM-DD format (UTC).
object
Subscription plan and invoicing cycle information.
object | null
Start and end dates of the current invoicing cycle. Informational only — null on free plans, which are never invoiced. On paid plans this normally matches creditCycle.
string
Billing cycle start date in YYYY-MM-DD format.
string
Billing cycle end date in YYYY-MM-DD format.
number
Total credit allowance for the credit cycle based on your plan.
string
The name of the subscription plan (e.g., "business", "professional").
object
Per-product credit consumption for the current credit cycle, in whole credits. Covers every product. Values are accumulated raw and rounded once at the end to match billing, so per-product credits may not sum exactly to creditsUsed after rounding.
number
Credits consumed by standard Solana RPC.
number
Credits consumed by the Enhanced API (e.g., parsed transactions, token metadata).
number
Credits consumed by the Wallet API.
number
Credits consumed by the DAS (Digital Asset Standard) API.
number
Credits consumed by Webhooks.
number
Credits consumed by LaserStream gRPC (bandwidth-metered).
number
Credits consumed by LaserStream WebSocket (bandwidth-metered).
number
Credits consumed by Preconfirmations.
number
Credits consumed by Archival.
number
Credits consumed by Photon (ZK Compression).
number
Credits consumed by uncategorized usage.
object
Request counts for the current credit cycle, for request-metered products only. The bandwidth-metered LaserStream products (laserstreamGrpc, laserstreamWebsocket) do not appear here — see dataTransfer. Fields: rpc, enhancedApi, walletApi, das, webhooks, preConfirmations, archival, photon, other.
object
Bytes transferred for the current credit cycle, for the bandwidth-metered LaserStream products only. These products are billed by data transferred, not request count, so they appear here and in credits but never in requests. Fields: laserstreamGrpc, laserstreamWebsocket.

Request Parameters

string
required
The project ID to retrieve usage for. Must match the project associated with the API key.

Authorizations

api-key
string
query
required

API key passed as a query parameter.

Path Parameters

id
string<uuid>
required

The project ID to retrieve usage for. Must match the project associated with the API key.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Project usage retrieved successfully.

creditsRemaining
number

Number of credits remaining in the current credit cycle. Calculated as creditsLimit - regularCreditsUsed, floored at 0.

Example:

487500

creditsUsed
number

Total credits consumed in the current credit cycle, including both regular and prepaid credits.

Example:

12500

prepaidCreditsRemaining
number

Number of prepaid credits remaining.

Example:

50000

prepaidCreditsUsed
number

Number of prepaid credits consumed in the current credit cycle.

Example:

0

creditCycle
object

The window every credit figure in this response is scoped to — the period credits accrue and reset against, derived from the subscription's billing anchor. Always present, for every plan, including free plans that are never invoiced.

subscriptionDetails
object

Details about the project's subscription plan and invoicing cycle.

credits
object

Per-product credit consumption for the current credit cycle, in whole credits. Covers every product. Values are accumulated raw and rounded once at the end to match billing, so per-product credits may not sum exactly to creditsUsed after rounding.

requests
object

Request counts for the current credit cycle, for request-metered products only. The bandwidth-metered LaserStream products (laserstreamGrpc, laserstreamWebsocket) do not appear here — see dataTransfer.

dataTransfer
object

Bytes transferred for the current credit cycle, for the bandwidth-metered LaserStream products only. These products are billed by data transferred, not request count, so they appear here and in credits but never in requests.