Get Credit Usage

Workspace-scoped subscription tier, enrichment credit usage, and quota limits.

Endpoint

GET /api/v1/account/credit-usage

Authentication

All requests require the X-Satellyte-API-Key header. See Quickstart.

Request

No body or query parameters.

cURL

curl -i "https://api-staging.satellyte.ai/api/v1/account/credit-usage" \
  -H "X-Satellyte-API-Key: $API_KEY"

Response (200)

{
  "data": {
    "workspace": {
      "id": "OWPayiJ2iK6dIZ4VOFxkP",
      "user_id": "H7OthRb1CSy0Q1OYS5u5H",
      "role": "admin",
      "email": "support@example.com"
    },
    "subscription": {
      "tier": "starter",
      "status": "active",
      "current_period_end": "2026-06-06T00:00:00.000Z",
      "pending_plan": null,
      "pending_plan_at": null
    },
    "credits": {
      "total": 1000,
      "used": 125,
      "remaining": 875,
      "unlimited": false,
      "bypassed": false
    },
    "limits": {
      "radars": {
        "used": 3,
        "limit": 10,
        "unlimited": false,
        "bypassed": false
      },
      "linkedInAccounts": {
        "used": 1,
        "limit": 3,
        "unlimited": false,
        "bypassed": false
      },
      "radarSignals": {
        "limit": 1000,
        "unlimited": false,
        "bypassed": false
      }
    },
    "generated_at": "2026-05-11T07:52:14.446Z"
  }
}

Response fields

Field	Type	Notes
`workspace`	object	Workspace mapped from the API key.
`subscription.tier`	string	For example `starter`, `growth`.
`subscription.status`	string \| null	Subscription status; `none` if no active plan.
`subscription.current_period_end`	string \| null	ISO timestamp of current billing period end.
`subscription.pending_plan`	string \| null	Pending plan change, if any.
`subscription.pending_plan_at`	string \| null	When the pending change takes effect.
`credits.total`	number \| null	Allocation for the active period. `null` if unlimited.
`credits.used`	number	Credits used in this period.
`credits.remaining`	number \| null	Credits remaining. `null` if unlimited.
`credits.unlimited`	boolean	Workspace has unlimited credits.
`credits.bypassed`	boolean	Credit limit manually bypassed.
`limits.*`	object	Radar, LinkedIn account, and signal usage and caps.
`generated_at`	string	ISO timestamp.

Workspaces on internal or bypassed plans may return credits.total: null with unlimited: true and bypassed: true: treat that as unlimited.

Error responses

All failed calls use the standard error envelope documented in Errors.

Status	Code	Notes
`401`	`unauthorized`	Returned when `X-Satellyte-API-Key` is missing, invalid, or expired.
`404`	`not_found`	Returned when Public API access is not enabled or the workspace context cannot be resolved.
`429`	`rate_limit_exceeded`	Returned when the API key exceeds its configured rate limit.
`500`	`service_error`	Returned when Satellyte cannot load credit usage or quota limits. Retry with backoff.