---
title: "Return hosted tenant plan, registry and scope overview"
method: GET
path: "/tenant/overview"
---

# Return hosted tenant plan, registry and scope overview

`GET /tenant/overview`

## Request

- Base URL: `https://api.gravityads.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gravityads.dev/tenant/overview`
- Auth: HTTP bearer

## Response `200`

Tenant overview

- object
  - `status` 'tenant_overview_ready', required
  - `tenant_id` string, required
  - `hosted_auth_context` object, required
  - `plan` object, required
  - `subscription` object, required
    - `status` string, required
    - `source` string
    - `tenant_id` string, required
    - `subscription_count` integer, required
    - `database_url_configured` boolean
    - `default_plan_id` string
    - `plan` object
    - `subscriptions` object[], required
      - `id` string, required
      - `tenant_id` string, required
      - `plan_id` string, required
      - `provider` string, required
      - `status` string, required
      - `currency` string
      - `current_period_start` string
      - `current_period_end` string
      - `cancel_at_period_end` boolean
      - `trial_start` string
      - `trial_end` string
      - `created_at` string
      - `updated_at` string
      - `provider_customer_id_present` boolean, required
      - `provider_customer_id_hash` string, required: Short SHA-256 hash prefix; raw cus_* ids are not returned.
      - `provider_subscription_id_present` boolean, required
      - `provider_subscription_id_hash` string, required: Short SHA-256 hash prefix; raw provider subscription ids are not returned.
    - `raw_provider_ids_returned` false, required
    - `raw_secrets_returned` false, required
  - `account_registry` object, required
  - `account_scope` object, required
    - `account_permission_count` integer, required
    - `account_permissions` object[], required
    - `source` string, required
  - `raw_secrets_returned` false, required

---

[API](https://skmtc.dev/gravityads/apis/gravityads-api.md) · [All operations](https://skmtc.dev/gravityads/apis/gravityads-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gravityads/apis/gravityads-api/revisions/124cd07d534d?raw)