Retrieve account usage and billing status

GET

https://api.segmentationapi.com/v1/account/overview

GET

/v1/account/overview

1 import { SegmentationAPIClient } from "@segmentationapi/sdk";
2 
3 async function main() {
4     const client = new SegmentationAPIClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.account.getAccountOverview();
8 }
9 main();

1 {
2   "tokenUsageLast24h": 1,
3   "billing": {
4     "accessStatus": "string",
5     "currentPeriodEnd": "string",
6     "latestInvoiceStatus": "string",
7     "stripeSubscriptionStatus": "string"
8   },
9   "access": {
10     "mode": "paid",
11     "reason": "paid_access",
12     "canCreateJobs": true,
13     "videoAllowed": true,
14     "downloadsAllowed": true,
15     "maxImageTasksPerJob": 1,
16     "maxActiveJobs": 1
17   },
18   "trial": {
19     "offerVersion": "string",
20     "status": "eligible",
21     "grantTokens": 1,
22     "consumedTokens": 1,
23     "remainingTokens": 1,
24     "durationDays": 1,
25     "startedAt": "2024-01-15T09:30:00Z",
26     "expiresAt": "2024-01-15T09:30:00Z",
27     "activeJobId": "string"
28   }
29 }

Authentication

AuthorizationBearer

Unrestricted secret sk_live_... or Cognito access token in Authorization: Bearer ...

Response

Overview

tokenUsageLast24hinteger

billingobject

accessobject

trialobject

Errors

401

Unauthorized Error