CentraPoint

API

Entitlements

Read your organisation's plan, feature flags, limits and custom features with GET /api/v1/me and GET /api/v1/entitlements/{key}.

On this page

Overview#

Your own apps and integrations can ask CentraPoint what the organisation behind an API key is entitled to: its plan, the built-in feature flags and limits, and any custom features. Use this to switch features on or off in your app instead of hard-coding plan names.

How entitlements are resolved#

  1. The organisation's plan sets the built-in flags and limits.
  2. Any adjustments made for your organisation are already applied to the flags and limits.
  3. Custom features take their value from the organisation's own override (if it hasn't expired), otherwise from the plan, otherwise they are off.

Get your organisation and entitlements#

GET/api/v1/me

Needs the REST API in your plan. Returns the organisation, plan, entitlements and the calling key:

curl -X GET "https://app.centrapoint.co.za/api/v1/me" \
  -H "Authorization: Bearer $CENTRAPOINT_API_KEY"
200 response
{
  "apiVersion": "1.18.0",
  "capabilities": {
    "externalSubscriptions": true
  },
  "tax": {
    "enabled": true,
    "name": "VAT",
    "rate": 15,
    "inclusive": false,
    "configured": true,
    "taxNumber": "4123456789"
  },
  "tenant": {
    "id": "cmg0t1n2t0001ten0001abcd",
    "name": "Acme (Pty) Ltd",
    "slug": "acme",
    "accountNumber": "CP100042",
    "status": "active",
    "kind": "customer",
    "billingCycle": "monthly",
    "pendingBillingCycle": null,
    "trialEndsAt": null,
    "currentPeriodEnd": "2026-10-31T21:59:59.000Z"
  },
  "plan": {
    "code": "business",
    "name": "Business",
    "currency": "ZAR",
    "priceMonthly": 1999,
    "priceYearly": 19990,
    "yearlyDiscountPercent": 16.67
  },
  "entitlements": {
    "features": {
      "featInvoicing": true,
      "featPaymentLinks": true,
      "featRecurring": true,
      "featDebitOrders": true,
      "featReconciliation": true,
      "featApi": true,
      "featAuditLog": true,
      "featCustomBranding": true,
      "featPrioritySupport": false,
      "featAccounting": true,
      "featReports": true,
      "featCustomerPortal": true,
      "featCoupons": true
    },
    "limits": {
      "maxUsers": 10,
      "maxProviders": null,
      "maxCustomers": null,
      "maxMonthlyTransactions": null,
      "maxApiKeys": 5,
      "maxMandates": 500
    },
    "custom": {
      "sms_notifications": {
        "enabled": true,
        "limit": 1000,
        "label": "SMS notifications"
      }
    }
  },
  "apiKey": {
    "name": "Production",
    "prefix": "cp_1a2b3c4d",
    "createdAt": "2026-09-01T10:00:00.000Z"
  }
}
Me fields
FieldTypeDescription
apiVersionrequiredstringVersion of this API, e.g. 1.18.0 (see the changelog). Integrations that need a feature can stop when it is older, for example subscription imports before 1.16.0.
taxrequiredobjectYour organisation's tax setting as it is charged: { enabled, name, rate, inclusive, configured, taxNumber }. enabled is false and rate is 0 when no tax is charged; inclusive says whether prices include it; configured: false means Settings → Tax was never saved and the legacy company VAT rate applies, added on top. Since 1.17.0.
capabilities.externalSubscriptionsrequiredbooleanWhether subscription imports (collectionMethod: external) are accepted now. false for a short time while CentraPoint is being updated; creates then answer 409 external_imports_unavailable.
tenantrequiredobjectid, name, slug, accountNumber, status, kind, billingCycle (monthly or yearly), pendingBillingCycle (a switch scheduled for the end of the paid period, else null; since 1.22.0), trialEndsAt, currentPeriodEnd.
planrequiredobject{ code, name, currency, priceMonthly, priceYearly, yearlyDiscountPercent } of the current plan. Paid yearly, a plan costs 12 months less the yearly discount; prices since 1.22.0 (0: priced on request).
entitlements.featuresrequiredobjectBuilt-in flag → true/false.
entitlements.limitsrequiredobjectBuilt-in limit → number, or null for unlimited.
entitlements.customrequiredobjectCustom feature key → { enabled, limit, label }.
apiKeyrequiredobject | null{ name, prefix, createdAt } of the key used.

Check one entitlement#

GET/api/v1/entitlements/{key}

key is a built-in flag, a built-in limit or a custom feature key (a letter followed by 1–63 letters, digits or underscores). Returns { key, enabled, limit }, or 404 not_found for an unknown key.

curl -X GET "https://app.centrapoint.co.za/api/v1/entitlements/sms_notifications" \
  -H "Authorization: Bearer $CENTRAPOINT_API_KEY"
200 response
{
  "key": "sms_notifications",
  "enabled": true,
  "limit": 1000
}
Entitlement response by key type
Key typeenabledlimit
Built-in flag (e.g. featRecurring)The flagnull
Built-in limit (e.g. maxUsers)false only when the limit is 0The limit; null = unlimited
Custom featureWhether it is onIts limit for limit-type features; null = unlimited or a plain flag

Built-in keys#

Built-in feature flags
KeyFeature
featInvoicingInvoicing
featPaymentLinksPayment links
featRecurringRecurring billing (gateway subscriptions and customer subscriptions)
featDebitOrdersDebit orders
featReconciliationReconciliation
featApiREST API & API keys
featAuditLogAudit log
featCustomBrandingCustom branding
featPrioritySupportPriority support
featAccountingAccounting integrations
featReportsReport builder
featCustomerPortalCustomer portal
featCouponsCoupons
Built-in limits
KeyLimit
maxUsersUsers
maxProvidersPayment gateways
maxCustomersCustomers
maxMonthlyTransactionsTransactions per month
maxApiKeysAPI keys
maxMandatesActive debit order mandates

Custom features#

Custom features have a lower-case key (e.g. sms_notifications), a label, a category and a kind (flag or limit). Your plan decides which custom features you have and their limits; an organisation-specific value may apply for a limited time. Only active custom features are returned.

Using entitlements in your app#

  • Fetch /api/v1/me when a user signs in to your app and cache the result for a few minutes.
  • Check limits against your own usage counts; null means unlimited.
  • Treat 404 from /api/v1/entitlements/{key} as "not entitled": the key was never defined or the custom feature was deactivated.
  • See Authentication for API keys and rate limits.