---
title: "Get the organization's subscription"
method: GET
path: "/organization/subscription"
tags: ["Organizations"]
---

# Get the organization's subscription

`GET /organization/subscription`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/organization/subscription`
- Auth: API key in header `x-api-key`

Returns the active plan with its name, status, billing period, and the plan features it includes. Admin or owner only — every other role gets a permission error and should read plan usage from `/organization/meters/{eventName}` instead.

## Response `200`

OK

- object
  - `id` string, required
  - `createdAt` string, date-time, required
  - `modifiedAt` string, date-time, nullable, required
  - `amount` number, required
  - `currency` string, required
  - `recurringInterval` union
    - 'day' | 'week' | 'month' | 'year'
    - unknown
  - `status` union
    - 'incomplete' | 'incomplete_expired' | 'trialing' | 'active' | 'past_due' | 'canceled' | 'unpaid' | 'paused'
    - unknown
  - `currentPeriodStart` string, date-time, required
  - `currentPeriodEnd` string, date-time, nullable, required
  - `cancelAtPeriodEnd` boolean, required
  - `canceledAt` string, date-time, nullable, required
  - `startedAt` string, date-time, nullable, required
  - `endsAt` string, date-time, nullable, required
  - `endedAt` string, date-time, nullable, required
  - `customerId` string, required
  - `productId` string, required
  - `discountId` string, nullable, required
  - `checkoutId` string, nullable, required
  - `planName` string, nullable, required: The subscribed plan's name.
  - `features` string[], required: Plan features this subscription includes, out of dataRetention, apiAccess, customSyncSchedule, unlimitedVideoTracking. A feature not listed is not included.

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)