Retrieve account usage and billing status

GET

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

GET

/v1/account/overview

import { SegmentationAPIClient } from "@segmentationapi/sdk";
async function main() {
    const client = new SegmentationAPIClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.account.getAccountOverview();
}
main();

{
  "tokenUsageLast24h": 1,
  "billing": {
    "accessStatus": "string",
    "currentPeriodEnd": "string",
    "latestInvoiceStatus": "string",
    "stripeSubscriptionStatus": "string"
  },
  "access": {
    "mode": "paid",
    "reason": "paid_access",
    "canCreateJobs": true,
    "videoAllowed": true,
    "downloadsAllowed": true,
    "maxImageTasksPerJob": 1,
    "maxActiveJobs": 1
  },
  "trial": {
    "offerVersion": "string",
    "status": "eligible",
    "grantTokens": 1,
    "consumedTokens": 1,
    "remainingTokens": 1,
    "durationDays": 1,
    "startedAt": "2024-01-15T09:30:00Z",
    "expiresAt": "2024-01-15T09:30:00Z",
    "activeJobId": "string"
  }
}

Authentication

Authorizationstring

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

Response

Overview

tokenUsageLast24hinteger

billingobject

accessobject

trialobject

Errors

401

Unauthorized Error