Skip to content
API referenceCheck whether the organization can be closed

Check whether the organization can be closed

GET/v1/organizations/{organization}/closure-eligibility

Check whether the organization can be closed.

Reports whether DELETE /v1/organizations/{organization} would be allowed now, and if not, why. Closing is blocked while the organization's credit account holds a positive balance (ORG_HAS_CREDIT_BALANCE) or while a credit withdrawal is still being refunded (WITHDRAWAL_IN_PROGRESS). An organization with no credit account is closeable, with a balance of 0.

Requires a member of the organization (any role), or an organization-scoped va_ key with the admin or member role. A workspace-scoped key is refused with 403.

Authorization

  • AuthorizationBearer va_

    A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

  • organizationstringrequired

    the organization's slug

Responses

200application/json
  • closeableboolean

    True when closing the organization would be allowed now.

  • blocking_reasonstring

    Why it cannot be closed: ORG_HAS_CREDIT_BALANCE (withdraw or spend the credit balance first) or WITHDRAWAL_IN_PROGRESS (a credit withdrawal is still being refunded). Absent when closeable is true.

  • credit_balance_usdnumber<double>

    The organization's credit balance, in USD; 0 when it has no credit account.

NVIDIA Inception Program member

VectorAxis is built by GK Labs, a member of NVIDIA Inception.