Account

curl https://intent-weasel-655.eu-west-1.convex.site/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "agency": {
    "id": "j57...",
    "name": "Acme Agency",
    "slug": "acme",
    "plan": "scale"
  },
  "apiTier": "advanced"
}

curl https://intent-weasel-655.eu-west-1.convex.site/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "agency": {
    "id": "j57...",
    "name": "Acme Agency",
    "slug": "acme",
    "plan": "scale"
  },
  "apiTier": "advanced"
}

Endpoints for your own agency: who you are and how much you’ve used this period.

Get your agency

Returns your agency and the API tier your current plan grants.

GET /me

curl https://intent-weasel-655.eu-west-1.convex.site/api/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"

object

Show properties

string

Your agency’s unique id.

string

Your agency’s display name.

string

Your subdomain slug (<slug>.brandless.app).

string

Your current plan: starter, growth, or scale.

string

basic (read-only) or advanced (read and write).

{
  "agency": {
    "id": "j57...",
    "name": "Acme Agency",
    "slug": "acme",
    "plan": "scale"
  },
  "apiTier": "advanced"
}

Get usage

Returns your usage for the current billing period, in US dollars.

GET /usage

curl https://intent-weasel-655.eu-west-1.convex.site/api/v1/usage \
  -H "Authorization: Bearer YOUR_API_KEY"

boolean

Whether billing is set up for this workspace.

number

Usage included with your plan this period.

number

Usage consumed so far this period.

number

Additional credits you’ve purchased.

number

Remaining balance available to spend.

string | null

ISO 8601 timestamp when the current period ends.

boolean

Whether the workspace is on a trial.

{
  "provisioned": true,
  "includedUsd": 150,
  "usedUsd": 0.172753,
  "purchasedUsd": 10,
  "availableUsd": 159.827247,
  "currentPeriodEnd": "2027-06-20T10:16:37.992Z",
  "isTrial": false
}

Getting started

Your brand

Clients

Building agents

Chat & embedding

Calendar

API

Billing your clients

Account & billing

Get your agency

Get usage

​Get your agency

​Get usage

Get your agency

Get usage