Skip to main content

billing.get

Read an organization’s seats and subscription

Request
GET/api/v1/organizations/{organizationSlug}/billing
Scope required
billing:read
Effect
Reads only. Safe to retry and safe for an agent to call unprompted.
Acts on
Acts on an organization, and names it in the path.
MCP tool
billing_get
Environment
Live and sandbox alike.
Request body
JSON.

What it does

Returns the seat allowance, how much of it is in use, the subscription behind it and what a seat costs on each cadence. Seats are counted against applicant members and invitations still waiting for an answer, so an organization can never oversell its allowance and discover the shortfall when somebody clicks an accept link. `isOverLimit` is what locks every staff read of applicant data, so check it here when `roster.list` or `organization_shares.list` starts answering 403. Both prices come back null on a deployment with no payment provider configured, which is never the same thing as free. Owners and admins may call it.

Parameters

Parameters this endpoint accepts, where each one goes, and whether it is required
NameSent inRequirementAccepts
organizationSlugpathRequiredstring

Response

canPurchase
boolean, required
pricing
object, required
annual
object or null, required
monthly
object or null, required
seats
object, required
available
integer, required
complimentarySeats
integer, required
freeSeats
integer, required
inUse
integer, required
isOverLimit
boolean, required
limit
integer, required
purchasedSeats
integer, required
subscriptionStatus
one of: incomplete, trialing, active, past_due, canceled, unpaid, paused or null, required
subscription
object or null, required

Examples

A career centre with twenty purchased seats

A career centre with twenty purchased seats — request
curl -s https://www.jobapplicationtracking.com/api/v1/organizations/northside-career-center/billing \
  -H "Authorization: Bearer $JAT_KEY"
A career centre with twenty purchased seats — response
{
  "seats": {
    "limit": 25,
    "inUse": 18,
    "available": 7,
    "isOverLimit": false,
    "freeSeats": 3,
    "complimentarySeats": 2,
    "purchasedSeats": 20,
    "subscriptionStatus": "active"
  },
  "subscription": {
    "status": "active",
    "purchasedSeats": 20,
    "billingInterval": "monthly",
    "currentPeriodEnd": "2026-03-11T17:05:00.000Z",
    "cancelAtPeriodEnd": false
  },
  "canPurchase": true,
  "pricing": {
    "monthly": {
      "interval": "monthly",
      "amountInMinorUnits": 500,
      "currency": "usd"
    },
    "annual": {
      "interval": "annual",
      "amountInMinorUnits": 5000,
      "currency": "usd"
    }
  }
}

Related operations