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

# Get Subscription

> Retrieve the authenticated user's current subscription information, including plan name, credit usage, concurrency limit, and custom voice slot capacity.

Use this endpoint to check remaining credits, verify your current plan, or see how many custom voice slots are available before cloning a new voice with `POST /v1/voices/clone`. The `limits.custom_voice_slot` value is the maximum number of custom voices the current plan can hold at once; free the slot by calling `DELETE /v1/voices/{voice_id}`.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/users/me/subscription
openapi: 3.1.0
info:
  title: Typecast API
  version: 0.1.2
  x-logo:
    url: https://typecast.ai/_ipx/_/image/logo/tc_logo.webp
servers:
  - url: https://api.typecast.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v1/users/me/subscription:
    get:
      tags:
        - Subscription
      summary: Get Subscription
      description: >-
        Retrieve the authenticated user's current subscription information,
        including plan name, credit usage, concurrency limit, and custom voice
        slot capacity.


        Use this endpoint to check remaining credits, verify your current plan,
        or see how many custom voice slots are available before cloning a new
        voice with `POST /v1/voices/clone`. The `limits.custom_voice_slot` value
        is the maximum number of custom voices the current plan can hold at
        once; free the slot by calling `DELETE /v1/voices/{voice_id}`.
      operationId: get_my_subscription_v1_users_me_subscription_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
              example:
                plan: lite
                credits:
                  plan_credits: 200000
                  used_credits: 157300
                limits:
                  concurrency_limit: 5
                  custom_voice_slot: 10
        '401':
          description: Unauthorized - Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail: Invalid API key
        '429':
          description: Too Many Requests - Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail: Too many requests
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail: An unexpected error occurred
components:
  schemas:
    SubscriptionResponse:
      type: object
      properties:
        plan:
          $ref: '#/components/schemas/PlanTier'
          description: Current subscription plan
        credits:
          $ref: '#/components/schemas/Credits'
          description: Credit usage information
        limits:
          $ref: '#/components/schemas/Limits'
          description: Usage limit information
      required:
        - plan
        - credits
        - limits
      title: SubscriptionResponse
      description: Subscription information response model
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Error message describing the issue
      required:
        - detail
      example:
        detail: An error occurred processing the request
    PlanTier:
      type: string
      enum:
        - free
        - lite
        - plus
        - custom
      title: PlanTier
      description: |-
        Subscription plan for the API.

        Available values:
        - **free**: Free tier with limited credits
        - **lite**: Lite plan with moderate credits
        - **plus**: Plus plan with higher credits
        - **custom**: Custom enterprise plan
    Credits:
      type: object
      properties:
        plan_credits:
          type: integer
          title: Plan Credits
          description: Total monthly credits provided by the plan
        used_credits:
          type: integer
          title: Used Credits
          description: Number of credits used
      required:
        - plan_credits
        - used_credits
      title: Credits
      description: Credit usage information
    Limits:
      type: object
      properties:
        concurrency_limit:
          type: integer
          title: Concurrency Limit
          description: Maximum number of concurrent requests allowed
        custom_voice_slot:
          type: integer
          minimum: 0
          title: Custom Voice Slot
          description: >-
            Maximum number of custom voices (created via instant cloning)
            allowed on the current plan.
          default: 0
      required:
        - concurrency_limit
      title: Limits
      description: Usage limit information
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        API key for authentication. You can obtain an API key from the Typecast
        API Console.

````