Get the organization's plan usage

GET

organization

usage

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.organization.usage();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "campaigns": {
    "level": "near",
    "limit": 5,
    "used": 4
  },
  "contacts": {
    "level": "near",
    "limit": 5,
    "used": 4
  },
  "emails": {
    "level": "near",
    "limit": 5,
    "used": 4,
    "month": "2026-07"
  },
  "object": "organization.usage",
  "plan": {
    "aiBudgetUsdMonthly": 50,
    "name": "Growth",
    "slug": "growth"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Response

campaigns

UsageMeter · object

required

Live campaigns (active + paused, not archived). Drafts are free.

Show child attributes

contacts

UsageMeter · object

required

Active (non-archived) people.

Show child attributes

emails

MonthlyEmailUsageMeter · object

required

Emails sent this UTC month (counted when accepted for delivery; skipped and failed sends don't count). Approximate. Resets on the 1st of the month (UTC).

Show child attributes

object

any

required

Object type. Always organization.usage.

plan

UsagePlan · object

required

The organization's current plan and its included AI budget.

Show child attributes

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.organization.usage();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "campaigns": {
    "level": "near",
    "limit": 5,
    "used": 4
  },
  "contacts": {
    "level": "near",
    "limit": 5,
    "used": 4
  },
  "emails": {
    "level": "near",
    "limit": 5,
    "used": 4,
    "month": "2026-07"
  },
  "object": "organization.usage",
  "plan": {
    "aiBudgetUsdMonthly": 50,
    "name": "Growth",
    "slug": "growth"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Get the organization's plan usage

Authorizations

Response