Skip to main content
GET
Returns the authenticated account’s active subscription plan — its expiry, billing state, and the full quota/permission set the plan grants.
Requires a Management API key with MANAGEMENT_API (or MANAGEMENT_API_SANDBOX) quota, sent as the raw Authorization header value — see the Management API overview.

Request

Verified live against a Pro-plan test account — pricing and payment_method are null on this account because it isn’t currently on a paid recurring billing cycle; plan.quotas is truncated above for brevity (a real response includes every quota the plan grants).

Response fields

boolean
Whether the plan is currently active (not expired, not cancelled).
boolean
Whether this is a free-tier plan.
string
Expiry date (YYYY-MM-DD), or the literal string "Lifetime" for a plan with no expiry.
boolean
Whether the plan has already expired.
integer
Days remaining until expire.
boolean
Whether auto-renewal is on.
boolean
Whether the account is eligible to cancel its subscription from the dashboard.
object | null
The account’s on-file payment method, or null if none is set (e.g. Free Trial/Enterprise-provisioned accounts).
object | null
The specific pricing/billing-period record this plan was purchased under ({id, name, period}, plus amount/currency when resolvable from order history), or null if the account has no billing history against this plan.
object
The plan definition itself.
object | null
Same shape as plan, if the account has a scheduled plan change (e.g. a downgrade taking effect at the end of the current billing cycle) — null otherwise.
The canonical Pro plan does not grant MANAGEMENT_API quota — only Free Trial, Enterprise, and Internal plans do in the verified test environment. If you’re building against this API and getting a 401 with "Your plan does not have management API quota.", check plan.quotas here for MANAGEMENT_API (or MANAGEMENT_API_SANDBOX) and contact support if you believe your plan should include it — there’s no self-serve upgrade path for this quota specifically at this time.
  • Management API overview — the environment-to-quota mapping (MANAGEMENT_API, INTEGRATION_ZAPIER, INTEGRATION_MCP) this endpoint’s plan.quotas codenames correspond to.
  • Create an API token — where a key’s environment determines which of these quotas gets checked.
  • Export analytics — an endpoint gated by the EXPORT_ANALYTICS_REPORT codename you can check for here.
  • Folder management — an endpoint gated by the FOLDER_MANAGEMENT codename you can check for here.

Authorizations

Authorization
string
header
required

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

Response

200 - application/json

Current plan detail — expiry, billing state, and the full quota/permission set the plan grants.