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

# Get subscription status

> Dashboard-only — session cookie auth. Current plan, subscription status, and renewal date.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/billing/subscription
openapi: 3.1.0
info:
  title: scrnshot API
  version: 1.0.0
  summary: Programmatic screenshot capture for developers.
  description: |
    scrnshot renders a URL and returns a hosted image. Authenticate with an
    API key (`X-API-Key`) for the endpoints under `/v1/screenshots` and
    `/v1/usage`. API-key management (`/v1/keys`) and billing endpoints use
    dashboard session cookies instead and are documented here for
    completeness — they are not part of the programmatic integration
    surface.

    Quotas are monthly (Free: 100/mo, Pro: 5,000/mo). Independently, requests
    are rate-limited per minute (Free: 5/min, Pro: 60/min). Exceeding the
    monthly quota returns `402`; exceeding the per-minute rate limit returns
    `429`.
servers:
  - url: https://api.scrnshot.site
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Screenshots
    description: Capture, list, and delete screenshots.
  - name: Usage
    description: Quota and rate-limit consumption.
  - name: API Keys
    description: |
      Dashboard-only. Authenticated with a session cookie, not an API key —
      a key cannot be used to mint or revoke other keys.
  - name: Billing
    description: Dashboard-only. Authenticated with a session cookie.
  - name: Demo
    description: |
      Unauthenticated, IP-rate-limited endpoint that powers the live demo on
      scrnshot.site. Not intended for integration — use `/v1/screenshots`
      with an API key instead.
paths:
  /v1/billing/subscription:
    get:
      tags:
        - Billing
      summary: Get subscription status
      description: >-
        Dashboard-only — session cookie auth. Current plan, subscription status,
        and renewal date.
      operationId: getSubscription
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
              example:
                plan: pro
                status: active
                current_period_end: '2026-08-20T00:00:00Z'
                cancel_at_period_end: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - SessionAuth: []
components:
  schemas:
    SubscriptionResponse:
      type: object
      required:
        - plan
        - status
      properties:
        plan:
          type: string
          enum:
            - free
            - pro
        status:
          type: string
          enum:
            - active
            - past_due
            - canceled
        current_period_end:
          type:
            - string
            - 'null'
          format: date-time
        cancel_at_period_end:
          type: boolean
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: unauthorized
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        Programmatic auth for the `/v1/screenshots` and `/v1/usage`
        endpoints. Create a key from the dashboard (`POST /v1/keys`); the
        plaintext value is shown once at creation.
    SessionAuth:
      type: apiKey
      in: cookie
      name: session
      description: |
        HttpOnly session cookie set on login. Used by the scrnshot dashboard
        only — `/v1/keys` and `/v1/billing/*` are not part of the
        programmatic API and cannot be called with an API key.

````