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

# Listar assinaturas

> Lista todas as assinaturas da sua conta.

Lista todas as assinaturas da sua conta. Paginacao por `page` e `limit` (maximo 100).

Se `page` estiver além do fim, a API retorna `data: []` com `total`, `page`, `limit` e `total_pages` validos.

Erros comuns: `400` (`page`/`limit` invalidos), `401`/`403` (auth/produto), `429` (20 req/min).


## OpenAPI

````yaml GET /v1/subscriptions
openapi: 3.0.0
info:
  title: UvviPay Public API
  description: >-
    Endpoints públicos da plataforma UvviPay para integração de subcontas
    (submerchants).
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.uvvipay.com.br
    description: Produção
  - url: https://api-staging.uvvipay.com.br
    description: Staging
security:
  - client-id: []
    client-secret: []
tags: []
paths:
  /v1/subscriptions:
    get:
      tags:
        - Assinaturas
      summary: Listar assinaturas
      description: >-
        Lista todas as assinaturas da sua conta. Se `page` estiver além do fim,
        retorna `data: []` com `total`, `page`, `limit` e `total_pages` válidos.
      operationId: listSubscriptions
      parameters:
        - name: client-id
          in: header
          description: ID público da credencial do merchant
          required: true
          schema:
            type: string
        - name: client-secret
          in: header
          description: Secret da credencial do merchant
          required: true
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Página (1-based)
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          description: Itens por página (máximo 100)
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
      responses:
        '200':
          description: >-
            Página de assinaturas. Página além do fim: `data: []` com metadados
            válidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscriptionsResponseDto'
        '400':
          description: Parâmetros inválidos (`page` ou `limit` fora do intervalo)
        '401':
          description: Credenciais inválidas ou ausentes
        '403':
          description: Produto `recurrency` não habilitado para o merchant
components:
  schemas:
    ListSubscriptionsResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionListItemDto'
          description: Página de assinaturas.
        total:
          type: integer
          description: Total de registros.
        page:
          type: integer
          description: Página atual.
        limit:
          type: integer
          description: Itens por página.
        total_pages:
          type: integer
          description: Total de páginas.
    SubscriptionListItemDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identificador da assinatura.
        subscription_status:
          type: string
          enum:
            - ACTIVE
            - PENDING
            - TRIAL
            - PAST_DUE
            - CANCELLED
          description: Status atual da assinatura.
        amount:
          type: integer
          description: Valor da assinatura em centavos.
        currency:
          type: string
          description: Moeda ISO 4217.
        next_billing_date:
          type: string
          format: date-time
          nullable: true
          description: Data da próxima cobrança.
        period_start_date:
          type: string
          format: date-time
          nullable: true
          description: Início do período vigente.
        period_end_date:
          type: string
          format: date-time
          nullable: true
          description: Fim do período vigente.
        created_at:
          type: string
          format: date-time
          description: Data de criação da assinatura.
        plan:
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanSummaryDto'
          description: Resumo do plano da assinatura.
        customer:
          allOf:
            - $ref: '#/components/schemas/SubscriptionCustomerSummaryDto'
          description: Resumo do cliente da assinatura.
    SubscriptionPlanSummaryDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identificador do plano.
        name:
          type: string
          description: Nome do plano.
        amount:
          type: integer
          description: Valor do plano em centavos.
        currency:
          type: string
          description: Moeda ISO 4217.
        interval:
          type: string
          description: Cadência de cobrança do plano.
    SubscriptionCustomerSummaryDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identificador do cliente na UvviPay.
        external_customer_id:
          type: string
          description: Identificador do cliente no seu sistema.
        name:
          type: string
          description: Nome do cliente.
        email:
          type: string
          description: E-mail do cliente.
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````