> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryhikoo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Subscription Details

> Plan info for the website: plan tier, product name, status, trial/expiry
dates, AI platforms covered, feature flags, and quotas. Agents use this to
tell the user which features require an upgrade.

Restricted to workspace OWNER and ADMIN. Members get 403 because billing
info (plan, expiry, quotas) is sensitive.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/website/subscription
openapi: 3.1.0
info:
  title: Hikoo REST API
  description: >-
    Programmatic access to your Hikoo data: citations, prompts, competitors,
    audits, health and more. Authenticate with a personal API key
    (`Authorization: Bearer <key>`) created from the dashboard settings.
  version: 1.0.0
servers:
  - url: https://api.tryhikoo.com
security:
  - apiKey: []
paths:
  /api/v1/public/website/subscription:
    get:
      tags:
        - Website
      summary: Get Subscription Details
      description: >-
        Plan info for the website: plan tier, product name, status, trial/expiry

        dates, AI platforms covered, feature flags, and quotas. Agents use this
        to

        tell the user which features require an upgrade.


        Restricted to workspace OWNER and ADMIN. Members get 403 because billing

        info (plan, expiry, quotas) is sensitive.
      operationId: get_subscription_details_api_v1_public_website_subscription_get
      parameters:
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Bearer <api_key>
            title: Authorization
          description: Bearer <api_key>
        - name: X-MCP-Secret
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Mcp-Secret
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionDetailsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SubscriptionDetailsResponse:
      properties:
        plan_tier:
          anyOf:
            - type: string
            - type: 'null'
          title: Plan Tier
        product_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Product Name
        status:
          type: string
          title: Status
        started_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Started At
        expires_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Expires At
        trial_ends_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Trial Ends At
        ai_platforms:
          items:
            type: string
          type: array
          title: Ai Platforms
        features:
          type: object
          title: Features
        quotas:
          type: object
          title: Quotas
      type: object
      required:
        - plan_tier
        - product_name
        - status
        - started_at
        - expires_at
        - trial_ends_at
        - ai_platforms
        - features
        - quotas
      title: SubscriptionDetailsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard (Settings > API keys).

````