curl --request GET \
--url https://api.scripe.io/v1/usage \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scripe.io/v1/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scripe.io/v1/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scripe.io/v1/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scripe.io/v1/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scripe.io/v1/usage")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scripe.io/v1/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"plan": "BUSINESS",
"canGenerate": true,
"blockedBy": "weekly_ai_budget",
"ai": {
"scope": "ai_project",
"percentUsed": 123,
"unlimited": true,
"enforcement": "off",
"weekStart": "2026-08-10",
"resetsAt": "2023-11-07T05:31:56Z",
"project": {
"id": "<string>",
"name": "<string>",
"percentUsed": 123,
"unlimited": true
},
"workspacePool": {
"percentUsed": 123,
"unlimited": true
}
},
"storage": {
"usedBytes": 123,
"limitBytes": 123,
"percentUsed": 123,
"usedAssets": 123,
"assetLimit": 123
},
"apiSpend": {
"bucketDate": "2026-08-14",
"capCents": 123,
"spentCents": 123,
"remainingCents": 123
}
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}Usage and limits
What the workspace has used of its limits, and whether the next AI job would be accepted.
Two 402s guard every AI verb — usage_limit_exceeded (the
weekly AI budget, the primary limit) and spend_cap_exceeded
(the daily API spend cap) — and this endpoint is the pre-flight
for both. Read canGenerate first: false means the next
post generation, image generation or knowledge ingest will
be refused, and blockedBy names which limit. canGenerate is
measured against the cost of a post generation, the most
common AI job.
AI budgets are reported as a percentage of the allowance,
never as money: the budget is denominated in provider cost, so
the meaningful figure for a customer is how much of the
allowance is gone. Storage is reported in bytes, and the daily
API cap in cents — both are already public (the cap appears in
the spend_cap_exceeded body).
With projectId the answer covers that project’s weekly
budget; without one it covers the workspace pool and
ai.project is null. A company page has no budget of its own
and spends from the pool, which ai.scope names.
Required scope: workspace:read.
curl --request GET \
--url https://api.scripe.io/v1/usage \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scripe.io/v1/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scripe.io/v1/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scripe.io/v1/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scripe.io/v1/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scripe.io/v1/usage")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scripe.io/v1/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"plan": "BUSINESS",
"canGenerate": true,
"blockedBy": "weekly_ai_budget",
"ai": {
"scope": "ai_project",
"percentUsed": 123,
"unlimited": true,
"enforcement": "off",
"weekStart": "2026-08-10",
"resetsAt": "2023-11-07T05:31:56Z",
"project": {
"id": "<string>",
"name": "<string>",
"percentUsed": 123,
"unlimited": true
},
"workspacePool": {
"percentUsed": 123,
"unlimited": true
}
},
"storage": {
"usedBytes": 123,
"limitBytes": 123,
"percentUsed": 123,
"usedAssets": 123,
"assetLimit": 123
},
"apiSpend": {
"bucketDate": "2026-08-14",
"capCents": 123,
"spentCents": 123,
"remainingCents": 123
}
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}Authorizations
Pass Authorization: Bearer scripe_sk_live_<...> (or
scripe_sk_test_<...> for test keys) on every request. Keys
are scoped to a single workspace and can be revoked from the
Scripe dashboard.
The same header also accepts an OAuth 2.1 access token
(scripe_oat_*); both credentials share one scope vocabulary
and every operation below documents the scope it requires.
An API key can hold every scope named on this surface except
webhooks:manage, which is grantable to OAuth tokens only
today — the webhook-endpoint operations answer
403 scope_missing to every API key. Operations that name no
scope accept any valid token of the workspace.
Headers
Pin the API version. Format YYYY-MM-DD. Omit to receive the
currently rolling default. Unknown versions return 400 version_unsupported.
"2026-08-10"
Query Parameters
Report the weekly AI budget of this project. Omit for the workspace pool alone.
"proj_project_40b15fd2eb034fa0"
Response
Current usage and limits.
Show child attributes
Show child attributes