---
title: "Fetch subscription"
method: GET
path: "/subscription"
tags: ["Subscriptions"]
---

# Fetch subscription

`GET /subscription`

## Request

- Base URL: `https://api.kisi.io`
- URL: `https://api.kisi.io/subscription`
- Auth: one of:
  - API key in header `Authorization`
  - OAuth 2
    - Authorization code: `https://api.kisi.io/oauth/authorize`
    - Token URL: `https://api.kisi.io/oauth/token`

## Response `200`

OK

- object
  - `id` integer, required: The ID of the subscription
  - `resource_type` 'Subscription', required: The resource type of the subscription
  - `created_at` string, date-time, required: When the subscription was created
  - `updated_at` string, date-time, required: When the subscription was updated
  - `name` string, required: The name of the subscription
  - `status` 'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'null', nullable, required: The status of the subscription
  - `reseller` boolean, required: Whether the subscription is for a reseller.
  - `reseller_contact_details` string, nullable, required: The contact details for the reseller
  - `resources` object, required
    - `access_keys` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `apple_passes` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `cameras` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `custom_roles` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `elevator_stops` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `group_links` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `incident_policies` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `integrations` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `locks` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `monthly_email_access_keys` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `monthly_email_group_links` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `monthly_sms_access_keys` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `monthly_sms_group_links` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `places` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `terminals` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `users` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
    - `zones` object, required
      - `count` integer, required: The total number of resources.
      - `quota` integer, nullable, required: The max allowed number of resources.
  - `addons` union[], required: Addons
    - union
      - object
        - `id` integer, required: The ID of the subscription addon
        - `resource_type` 'SubscriptionAddon', required: The resource type of the subscription addon
        - `status` 'active' | 'inactive', required: The status of the addon.
        - `plan` string, required: The plan of the addon.
        - `message` string, nullable, required: An optional message of the addon.
        - `created_at` string, date-time, required: When the subscription addon was created
        - `updated_at` string, date-time, required: When the subscription addon was updated
        - `subscription_id` integer, required: The subscription ID of the subscription addon
        - `type` 'feature', required
        - `feature` 'support_portal' | 'segment' | 'tailgating' | 'monitoring', required: The feature the addon applies to.
      - object
        - `id` integer, required: The ID of the subscription addon
        - `resource_type` 'SubscriptionAddon', required: The resource type of the subscription addon
        - `status` 'active' | 'inactive', required: The status of the addon.
        - `plan` string, required: The plan of the addon.
        - `message` string, nullable, required: An optional message of the addon.
        - `created_at` string, date-time, required: When the subscription addon was created
        - `updated_at` string, date-time, required: When the subscription addon was updated
        - `subscription_id` integer, required: The subscription ID of the subscription addon
        - `type` 'resource', required
        - `applies_to_id` integer, required: The ID of the resource the addon applies to.
        - `applies_to_type` 'MarketplaceApp' | 'VisualizationPage', required: The type of the resource the addon applies to.
  - `organization_id` integer, required: The organization ID of the subscription
  - `organization` object, required: The organization of the subscription
    - `id` integer, required: The ID of the organization
    - `resource_type` 'Organization', required: The resource type of the organization
    - `name` string, required: The name of the organization
    - `domain` string, required: The domain of the organization.
  - `place_id` integer, nullable, required: The place ID of the subscription

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

## Changes

- **2026-10-20** `a6bb22e5df9d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/kisi/apis/kisi-api/changes/subscription/get.md)

---

[API](https://skmtc.dev/kisi/apis/kisi-api.md) - [All operations](https://skmtc.dev/kisi/apis/kisi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kisi/apis/kisi-api/revisions/892ee0d3a464?raw)