---
title: "Get subscription data"
method: GET
path: "/api/v2/organizations/subscription/data"
tags: ["Subscriptions"]
---

# Get subscription data

`GET /api/v2/organizations/subscription/data`

## Request

- Base URL: `https://api.chirpwireless.io`
- URL: `https://api.chirpwireless.io/api/v2/organizations/subscription/data`
- Auth: API key in header `X-API-Key` and API key in header `X-Organization-Id`

Retrieve current subscription plan and usage for the organization.

**Required scope:** `subscriptions:read`

## Query parameters

- `organizationId` string, required

## Response `200`

OK

- object
  - `current_usage` object
    - `dashboard_count` integer
    - `devices_count` integer
    - `rules_count` integer
  - `subscription` object
    - `current_period_end` string
    - `current_period_start` string
    - `features` object
      - `custom_dashboards` integer
      - `device_logs` integer
      - `devices` integer
      - `email_notifications` boolean
      - `email_support` boolean
      - `notification_center` boolean
      - `phone_push_notifications` boolean
      - `rules` integer
      - `unlimited_gateways` boolean
    - `plan` object
      - `amount` integer
      - `currency` string
      - `interval` string
      - `name` string
      - `stripe_price_id` string
      - `stripe_product_id` string
    - `status` string
    - `stripe_customer_id` string
    - `stripe_subscription_id` string

## Other responses

- `401`: Missing or invalid API key
- `403`: Insufficient permissions (missing required scope)

---

[API](https://skmtc.dev/chirpwireless/apis/chirp-public-api.md) · [All operations](https://skmtc.dev/chirpwireless/apis/chirp-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chirpwireless/apis/chirp-public-api/revisions/0414f3e239ff?raw)