---
title: "Paid features and add-ons: what the organization may use now, and the plan or Build Credits that unlock the rest (projects:read or billing:read). A locked feature answers 402 upgrade_required when used (docs/ENTITLEMENTS.md)"
method: GET
path: "/billing/entitlements"
tags: ["Billing"]
---

# Paid features and add-ons: what the organization may use now, and the plan or Build Credits that unlock the rest (projects:read or billing:read). A locked feature answers 402 upgrade_required when used (docs/ENTITLEMENTS.md)

`GET /billing/entitlements`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/billing/entitlements`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Query parameters

- `orgId` string: Organization id (required when you belong to several)

## Response `200`

Entitlements

- object
  - `organizationId` string, uuid, required
  - `plan` string, required: the organization's plan (free, pro, business), or unlimited (no plan limits, set by the operator)
  - `enforced` boolean, required: false: this server does not enforce paid features (a development server without billing) and allows everything
  - `billingConfigured` boolean, required: plans and Build Credits can be bought on this server; false: offer to get in touch instead of Checkout
  - `purchasedCredits` number, required: purchased Build Credits left: what credit-priced add-ons are paid from (the plan's own allowance is not)
  - `features` object[], required
    - `feature` 'builder.publish' | 'builder.custom_domain' | 'builder.auto_seo' | 'builder.github_export' | 'builder.forms' | 'builder.shop' | 'site.multilingual' | 'wordpress.ai_assistant' | 'wordpress.connect_external' | 'agents.runtime', required
    - `allowed` boolean, required
    - `requires` 'plan' | 'plan_or_credits', required: what unlocks it: a paid plan, or a paid plan or purchased Build Credits
    - `unlockedBy` 'plan' | 'credits' | 'unlimited' | 'open' | 'null', nullable, required: why it is allowed: the plan includes it, purchased Build Credits pay for it, the organization has no plan limits, or this server does not enforce paid features (open); null = locked
    - `includedIn` string[], required: plans that include it at no extra cost
    - `creditsPerUse` number, nullable, required: Build Credits one use costs without such a plan (per_use), or the balance a use needs to start (metered); null for plan-only features
    - `charge` 'per_use' | 'metered' | 'null', nullable, required: per_use: charged once per use; metered: its AI usage is charged in Build Credits as it goes; null for plan-only features
  - `allowedClasses` string[], nullable: the site classes the plan of the team hosts (migration 203; null = every class); absent when billing could not be read

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden); details.requiresSession for plan/payment changes over a token
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state, e.g. a subscription already exists (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `501`: Billing is not set up on this server (code not_configured)
- `503`: The payment provider is unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)