Skip to content

Entitlements

What the current plan allows. Read this instead of hard-coding limits, and instead of discovering them by hitting a 422.

This endpoint ignores X-Postlyra-Brand

It reads your currently-selected brand. Call PATCH /me/team first to target a specific one.

GET /me/entitlements

bash
curl https://api.postlyra.com/me/entitlements \
  -H "Authorization: Bearer $POSTLYRA_TOKEN"
json
{
  "team_id": 1,
  "plan": { "id": 3, "slug": "solo", "name": "Solo" },
  "entitlements": {
    "brands": { "type": "limit", "value": 1, "available": true, "source": "plan" },
    "ai_credits_monthly": { "type": "limit", "value": 10000, "available": true, "source": "plan" },
    "storage_limit": { "type": "limit", "value": 5, "available": true, "source": "plan", "used": 1.482 },
    "staff_accounts": { "type": "limit", "value": 2, "available": true, "source": "plan" },
    "automations": { "type": "limit", "value": 3, "available": true, "source": "plan" }
  }
}

Reading a value

FieldMeaning
typelimit, boolean or enum
valueThe allowance. For a limit, null means unlimited
availableWhether the feature is usable at all
sourceplan, grant or default
is_unlimitedPresent on a limit with no ceiling
usedPresent on storage_limit only, in GB to 3 decimals

A feature that is switched off entirely is omitted from the response, not returned as false. Treat a missing key as unavailable.

source tells you where the value came from: plan is the plan's default, grant is an override applied to this account specifically, and default means neither applied.

The allowances

KeyControls
brandsHow many brands the account can create
ai_credits_monthlyMonthly AI generation budget
storage_limitMedia storage, in GB
staff_accountsMember seats per brand
automationsHow many automations can be active at once

Where they bite

AllowanceEnforced on
storage_limitPOST /media, returns 422
staff_accountsPOST /users, returns 422 with limit_reached
brandsCreating a brand in Studio
automationsActivating an automation in Studio
ai_credits_monthlyAny AI generation in Studio

Trials

An account on trial resolves against a hidden trial plan: 1 brand, 10,000 AI credits, 5 GB storage, 2 seats, 3 automations. An account past its trial with no subscription has no plan, so plan is null and most allowances are unavailable.

GET /subscription/status tells you which state you are in. See Subscription.

Postlyra, by MAVA Design