Skip to Content

Your plan, areas and usage

Needs the scope account:read

The account summary an agent reads before it orders: the plan, the areas switched on, what was used in the period and what is left per kind, and this token's own limits.

Response Body

OK

application/json
  1. response
client*

The company the key belongs to.

plan*

contract: managed by your CharpstAR contact. package: chosen through the API. none: nothing active yet; the account can read and explore but not order.

areas*array<>

The product areas switched on for the account.

period*

The calendar year (UTC), unless the plan says otherwise.

currency*string

ISO 4217. The currency prices and invoices are in: from the company's country, unless agreed otherwise.

Length3 <= length <= 3
usage*array<>
limits*

This token's own limits.

Example Request
curl -sS https://platform.charpstar.co/api/v1/account \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "client": {    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",    "name": "Your Company"  },  "plan": {    "kind": "contract",    "name": "standard",    "activatedAt": "2026-01-15T00:00:00.000Z"  },  "areas": [    "models",    "renders",    "ai_studio"  ],  "period": {    "kind": "year",    "startsAt": "2026-01-01T00:00:00.000Z",    "endsAt": "2027-01-01T00:00:00.000Z"  },  "currency": "SEK",  "usage": [    {      "kind": "model_ordered",      "used": 182,      "allowance": 200,      "remaining": 18,      "period": {        "kind": "year",        "startsAt": "2026-01-15T00:00:00.000Z",        "endsAt": "2027-01-15T00:00:00.000Z"      },      "unitPrice": null    },    {      "kind": "model_delivered",      "used": 164,      "allowance": null,      "remaining": null,      "period": {        "kind": "year",        "startsAt": "2026-01-01T00:00:00.000Z",        "endsAt": "2027-01-01T00:00:00.000Z"      },      "unitPrice": null    },    {      "kind": "model_replaced",      "used": 7,      "allowance": 20,      "remaining": 13,      "period": {        "kind": "year",        "startsAt": "2026-01-01T00:00:00.000Z",        "endsAt": "2027-01-01T00:00:00.000Z"      },      "unitPrice": null    },    {      "kind": "packshot",      "used": 1240,      "allowance": null,      "remaining": null,      "period": {        "kind": "year",        "startsAt": "2026-01-01T00:00:00.000Z",        "endsAt": "2027-01-01T00:00:00.000Z"      },      "unitPrice": null    },    {      "kind": "scene",      "used": 96,      "allowance": null,      "remaining": null,      "period": {        "kind": "year",        "startsAt": "2026-01-01T00:00:00.000Z",        "endsAt": "2027-01-01T00:00:00.000Z"      },      "unitPrice": null    },    {      "kind": "edit",      "used": 31,      "allowance": null,      "remaining": null,      "period": {        "kind": "year",        "startsAt": "2026-01-01T00:00:00.000Z",        "endsAt": "2027-01-01T00:00:00.000Z"      },      "unitPrice": null    },    {      "kind": "video",      "used": 12,      "allowance": null,      "remaining": null,      "period": {        "kind": "year",        "startsAt": "2026-01-01T00:00:00.000Z",        "endsAt": "2027-01-01T00:00:00.000Z"      },      "unitPrice": null    },    {      "kind": "export",      "used": 58,      "allowance": null,      "remaining": null,      "period": {        "kind": "year",        "startsAt": "2026-01-01T00:00:00.000Z",        "endsAt": "2027-01-01T00:00:00.000Z"      },      "unitPrice": null    }  ],  "limits": {    "requestsPerMinute": 120,    "requestsPerDay": 5000,    "writesPerDay": null  }}