Skip to content

Get the organization's closure

The organizations.closure.get operation: GET /api/v1/organizations/{id}/closure in the REST API and the organizations_closure_get tool in the MCP server.

GET/api/v1/organizations/{id}/closure

Returns the organization's status and, once closing started, the closure: how subscriptions end, when they were cancelled and ended, what still holds the closure (blockers: subscriptions not ended yet, open invoices, pending refunds, final filing periods not submitted), when it closed and until when its financial records are kept. closure is null for an organization that isn't closing.

At a glance

  • REST: GET /api/v1/organizations/{id}/closure
  • MCP tool: organizations_closure_get
  • Operation ID: organizations.closure.get
  • Scope: Organization
  • Permission: org:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Authentication: API key with the org:read scope
  • Since: M12

Request

Path parameters

FieldTypeDescription
idorg_… ID

Query parameters

This operation takes no query parameters.

Response

200 OK with a JSON object:

FieldTypeDescription
object"organization_closure_status"
orgIdorg_… ID
statusstring
closureobject or null

Examples

Closing, subscriptions still running

HTTP
GET /api/v1/organizations/org_01m4tx5nj7ekd958x53w4bntcg/closure
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "organization_closure_status",
  "orgId": "org_01m4tx5nj7ekd958x53w4bntcg",
  "status": "closing",
  "closure": {
    "object": "organization_closure",
    "orgId": "org_01m4tx5nj7ekd958x53w4bntcg",
    "status": "closing",
    "subscriptions": "period_end",
    "reason": "We're winding the company down.",
    "requestedAt": "2026-10-26T09:00:00.000Z",
    "requestedBy": {
      "type": "user",
      "id": "usr_01m4tx5nj8emwbyf7y9vcf47xa"
    },
    "subscriptionsCancelledAt": null,
    "subscriptionsEndedAt": null,
    "closedAt": null,
    "retainUntil": null,
    "blockers": [
      {
        "blocker": "subscriptions",
        "count": 12
      }
    ]
  }
}

Errors

CodeHTTP statusWhenWhat to do
resource_not_found404The ID isn't the organization of the request.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
permission_denied403You can't read this organization.Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, dry_run_not_supported, rate_limited, internal_error.