GET/v1/organisation/plan

The organisation plan and its usage

The subscribed plan, the effective entitlements (plan merged with any overrides) and the usage against them: Postflows in use, items released this month, webhook endpoints, fonts and storage. Limits answer with postflow_limit_reached, product_not_entitled, feature_not_entitled or allowance_exceeded at the point of use.

Scope templates.read

Returns

4 fields of the 200 answer

planobject or nullrequired

5 fields

idstringrequired

keystringrequired

namestringrequired

monthlyFeeCentsintegerrequired

currencystringrequired

subscriptionobject or nullrequired

6 fields

idstringrequired

planIdstringrequired

statusenumrequired

ACTIVEENDEDCANCELLED

startsAtdate-timerequired

endsAtdate-time or nullrequired

createdAtdate-timerequired

entitlementsobjectrequired

8 fields

maxPostflowsinteger or nullrequired

monthlyItemAllowanceobjectrequired

2 fields

limitinteger or nullrequired

hardCapbooleanrequired

enabledProductIdsone ofrequired

maxStorageMbinteger or nullrequired

maxFontsinteger or nullrequired

maxImportRowsinteger or nullrequired

maxWebhookEndpointsinteger or nullrequired

featuresarray of enumrequired

qrTrackingsamplesapiAccessrunSchedule

usageobjectrequired

5 fields

postflowsobjectrequired

2 fields

usedintegerrequired

maxinteger or nullrequired

itemsThisMonthobjectrequired

4 fields

usedintegerrequired

limitinteger or nullrequired

hardCapbooleanrequired

periodStartdate-timerequired

webhookEndpointsobjectrequired

2 fields

usedintegerrequired

maxinteger or nullrequired

fontsobjectrequired

2 fields

usedintegerrequired

maxinteger or nullrequired

storageobjectrequired

2 fields

usedBytesintegerrequired

maxMbinteger or nullrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

{ "plan": { "id": "pln_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "key": "first_name", "name": "Welcome card", "monthlyFeeCents": 1250, "currency": "EUR" }, "subscription": { "id": "sub_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "planId": "pln_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "status": "ACTIVE", "startsAt": "2026-10-16T09:14:02.000Z", "endsAt": "2026-10-16T09:14:02.000Z", "createdAt": "2026-10-16T09:14:02.000Z" }, "entitlements": { "maxPostflows": 1, "monthlyItemAllowance": { "limit": 20, "hardCap": false }, "enabledProductIds": "all", "maxStorageMb": 1, "maxFonts": 1, "maxImportRows": 1, "maxWebhookEndpoints": 1, "features": [ "qrTracking" ] }, "usage": { "postflows": { "used": 1, "max": 1 }, "itemsThisMonth": { "used": 1, "limit": 20, "hardCap": false, "periodStart": "2026-10-16T09:14:02.000Z" }, "webhookEndpoints": { "used": 1, "max": 1 }, "fonts": { "used": 1, "max": 1 }, "storage": { "usedBytes": 1, "maxMb": 1 } } }