Skip to content
SegmentationAPI

Retrieve account usage and billing status

GET
/v1/account/overview
curl --request GET \
  --url https://api.segmentationapi.com/v1/account/overview \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Overview

Media typeapplication/json
object
tokenUsageLast24h
required
integer
billing
required
object
accessStatus
string
currentPeriodEnd
string
latestInvoiceStatus
string
stripeSubscriptionStatus
string
access
required
object
mode
required
string
Allowed values: paid trial blocked
reason
required
string
Allowed values: paid_access trial_eligible trial_active trial_exhausted trial_expired billing_delinquent
canCreateJobs
required
boolean
videoAllowed
required
boolean
downloadsAllowed
required
boolean
maxImageTasksPerJob
required
integer
maxActiveJobs
required
integer
trial
required
object
offerVersion
required
string
status
required
string
Allowed values: eligible active exhausted expired
grantTokens
required
integer
consumedTokens
required
integer
remainingTokens
required
integer
durationDays
required
integer
startedAt
required
string format: date-time
nullable
expiresAt
required
string format: date-time
nullable
activeJobId
required
string
nullable
Example
{
  "access": {
    "mode": "paid",
    "reason": "paid_access"
  },
  "trial": {
    "status": "eligible"
  }
}

401

Section titled “401”

Authentication is missing, invalid, or expired

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}