Billing state (financial + entitlement)
curl --request GET \
--url https://api.signuprisk.com/v1/dashboard/billing \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.signuprisk.com/v1/dashboard/billing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.signuprisk.com/v1/dashboard/billing"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.signuprisk.com/v1/dashboard/billing"
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))
}{
"plan": "<string>",
"billing_interval": "<string>",
"subscription_status": "incomplete",
"checkout_state": "none",
"cancel_at_period_end": true,
"has_stripe_customer": true,
"local": true,
"current_period_start": "2023-11-07T05:31:56Z",
"current_period_end": "2023-11-07T05:31:56Z",
"effective_plan": "<string>",
"access_state": "active",
"grace_until": "2023-11-07T05:31:56Z",
"entitlement_reason": "<string>"
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}Billing
Billing state (financial + entitlement)
Financial state (subscription_status) is distinct from runtime access state (effective_plan / access_state). Do not infer access from Stripe status; the entitlement snapshot controls runtime access.
GET
/
v1
/
dashboard
/
billing
Billing state (financial + entitlement)
curl --request GET \
--url https://api.signuprisk.com/v1/dashboard/billing \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.signuprisk.com/v1/dashboard/billing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.signuprisk.com/v1/dashboard/billing"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.signuprisk.com/v1/dashboard/billing"
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))
}{
"plan": "<string>",
"billing_interval": "<string>",
"subscription_status": "incomplete",
"checkout_state": "none",
"cancel_at_period_end": true,
"has_stripe_customer": true,
"local": true,
"current_period_start": "2023-11-07T05:31:56Z",
"current_period_end": "2023-11-07T05:31:56Z",
"effective_plan": "<string>",
"access_state": "active",
"grace_until": "2023-11-07T05:31:56Z",
"entitlement_reason": "<string>"
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}Authorizations
Clerk dashboard session JWT. Used on dashboard, billing, playground, and admin console routes only:
Authorization: Bearer <Clerk session JWT>
These are human-session credentials, not API keys. The dashboard
frontend must never send authoritative account IDs, plan values, quota
counters, Stripe IDs, or API-key actor fields — the server derives
ownership from the session. Admin console routes additionally require
the custom admin_role claim (admin or support) on the same
verified session JWT; writes require admin.
Response
Billing state.
Available options:
incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused Available options:
none, checkout_pending Runtime effective plan from entitlement snapshot.
Available options:
active, grace, lapsed, none