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

# List Subscriptions



## OpenAPI

````yaml /api-reference/proxy.json get /v1/proxy/subscriptions
openapi: 3.1.0
info:
  title: Lumi Proxy API
  version: 1.1.0
  description: >-
    Публичный REST API прокси Lumi. Ключ привязан к одному аккаунту и делает то
    же, что клиент делает в боте.


    Авторизация: `Authorization: Bearer <ключ>`. Денежные запросы дополнительно
    требуют заголовок `Idempotency-Key`.
servers:
  - url: https://api.lumiweb.cc/proxy
    description: production
security:
  - bearerAuth: []
paths:
  /v1/proxy/subscriptions:
    get:
      tags:
        - proxy
      summary: List Subscriptions
      operationId: list_subscriptions
      parameters:
        - name: category
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 32
              - type: 'null'
            title: Category
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 32
              - type: 'null'
            title: Status
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
            title: Limit
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Cursor
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_SubscriptionOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Page_SubscriptionOut_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/SubscriptionOut'
          type: array
          title: Items
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
        has_more:
          type: boolean
          title: Has More
          default: false
      type: object
      required:
        - items
      title: Page[SubscriptionOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SubscriptionOut:
      properties:
        id:
          type: integer
          title: Id
        user_id:
          type: integer
          title: User Id
        package_title:
          type: string
          title: Package Title
        category:
          type: string
          title: Category
        protocol:
          type: string
          title: Protocol
        status:
          type: string
          title: Status
        traffic_gb:
          anyOf:
            - type: integer
            - type: 'null'
          title: Traffic Gb
        traffic_gb_total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Traffic Gb Total
        traffic_limit_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Traffic Limit Bytes
        traffic_used_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Traffic Used Bytes
        ip_quantity:
          anyOf:
            - type: integer
            - type: 'null'
          title: Ip Quantity
        auto_renew:
          type: boolean
          title: Auto Renew
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
        purchase_price_usd:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Purchase Price Usd
        kind:
          type: string
          title: Kind
          description: '''static'' | ''rotating'''
          default: rotating
        access_mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Access Mode
          description: '''api_tool'' | ''legacy'' - rotating subscriptions only'
        targeting:
          anyOf:
            - $ref: '#/components/schemas/TargetingOut'
            - type: 'null'
        capabilities:
          items:
            type: string
          type: array
          title: Capabilities
          description: >-
            Operations this subscription supports right now (export, rotate,
            settings, traffic_topup, renew, auto_renew, password_reset)
      type: object
      required:
        - id
        - user_id
        - package_title
        - category
        - protocol
        - status
        - auto_renew
        - purchase_price_usd
      title: SubscriptionOut
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    TargetingOut:
      properties:
        country_iso:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Iso
        country_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Name
        region:
          anyOf:
            - type: string
            - type: 'null'
          title: Region
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
        isp:
          anyOf:
            - type: string
            - type: 'null'
          title: Isp
        rotation_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Rotation Seconds
          description: null = a new IP as often as the pool allows
        session_mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Mode
        protocol:
          anyOf:
            - type: string
            - type: 'null'
          title: Protocol
        format:
          anyOf:
            - type: string
            - type: 'null'
          title: Format
      type: object
      title: TargetingOut
      description: Geo / rotation snapshot stored on the subscription.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Ключ вида lumi_proxy_… Выдаётся оператором.

````