---
title: "Current subscription, effective plan, and feature allowances"
method: GET
path: "/v1/subscriptions/me"
---

# Current subscription, effective plan, and feature allowances

`GET /v1/subscriptions/me`

## Request

- Base URL: `https://api.hify.club`
- URL: `https://api.hify.club/v1/subscriptions/me`
- Auth: API key in header `X-User-Token`

## Response `200`

Subscription state for the current user

- object
  - `subscription` Subscription, nullable
    - `id` integer
    - `status` 'created' | 'authenticated' | 'active' | 'past_due' | 'halted' | 'cancelled' | 'completed'
    - `pg` string
    - `current_period_start` string, date-time, nullable
    - `current_period_end` string, date-time, nullable
    - `cancel_at_period_end` boolean
    - `payment_method_summary` object
  - `plan` object
  - `allowances` object[]
    - `feature` string
    - `limit_type` 'unlimited' | 'quota'
    - `quota` integer, nullable
    - `used` integer, nullable
    - `remaining` integer, nullable

---

[API](https://skmtc.dev/hify/apis/hify-apis.md) - [All operations](https://skmtc.dev/hify/apis/hify-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/hify/apis/hify-apis/revisions/b5920403538d?raw)
