API reference / Get the organization's billing-lock detail

Get the organization's billing-lock detail

GET/billing/details

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

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Response

billingPlanPublicBillingPlanEnumRequired

The organization's plan.

Available options:FREEGROWTHPREMIUM

subscriptionStatusPublicSubscriptionStatusEnumRequired

Lifecycle status of the Chargebee subscription.

Available options:FUTUREIN_TRIALACTIVENON_RENEWINGPAUSEDCANCELLEDTRANSFERRED

effectiveEntitlementPublicEffectiveEntitlementEnumRequired

Effective feature tier, which can read higher than billingPlan for a partner-associated or test organization.

Available options:FREEPAIDPREMIUM

billingPresetPublicBillingPresetEnum

Sales-led Premium staging while the organization is still FREE. Does not unlock Premium entitlements by itself.

Available options:NONEPREMIUM

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

404

The requested resource was not found.

422

Validation Error