Get the organization's billing-lock detail
Returns the plan, subscription status, and effective entitlement for the org selected by Organization-Id, Connection-Id, or Entity-Id. This is what gates access to most of the product.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-10-06.
Target organization id (Organization-Id selector).
Target connection id; resolves to its organization.
Platform entity id; resolves to a connection's organization.
Optional source to disambiguate an Entity-Id.
Response
The organization's plan.
FREEGROWTHPREMIUMLifecycle status of the Chargebee subscription.
FUTUREIN_TRIALACTIVENON_RENEWINGPAUSEDCANCELLEDTRANSFERREDEffective feature tier, which can read higher than billingPlan for a partner-associated or test organization.
FREEPAIDPREMIUMSales-led Premium staging while the organization is still FREE. Does not unlock Premium entitlements by itself.
NONEPREMIUMAccess to each capability, one entry per capability. null when access does not depend on per-capability settings for this organization; gate on effectiveEntitlement instead.
Successful Response
The request was invalid.
Authentication failed or was missing.
The requested resource was not found.
Validation Error