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

# List Subscriptions

> Retorna a lista de assinaturas do ambiente da chave utilizada, ordenadas da mais recente para a mais antiga, com paginação por limit/offset e filtro opcional por status.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/subscriptions
openapi: 3.1.0
info:
  title: PurinCash API
  version: 1.0.0
servers:
  - url: https://api.purincash.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Cartao
    description: Pagamentos no cartao de credito.
  - name: Cobrancas
    description: Cobrancas PIX avulsas com valor livre.
  - name: Entregas
    description: Conteudo entregue automaticamente apos o pagamento.
  - name: Disputas
    description: Contestacoes (MED) e envio de evidencias.
  - name: Pagamentos
    description: Pagamentos PIX e LTC vinculados ou nao a um produto.
  - name: Saques
    description: Saques em PIX, LTC e USDT.
  - name: Produtos
    description: Produtos de cobranca criados pela API.
  - name: Sandbox
    description: Simulacao de pagamentos e saldo de teste.
  - name: Splits
    description: Cobrancas divididas entre varias contas.
  - name: Loja
    description: Produtos da loja do Discord (somente leitura).
  - name: Assinaturas
    description: PIX recorrente.
  - name: Carteira
    description: Saldo, retencoes e valores a liberar.
paths:
  /v1/subscriptions:
    get:
      tags:
        - Assinaturas
      summary: List Subscriptions
      description: >-
        Retorna a lista de assinaturas do ambiente da chave utilizada, ordenadas
        da mais recente para a mais antiga, com paginação por limit/offset e
        filtro opcional por status.
      operationId: listSubscriptions
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Quantidade máxima de itens por página (1 a 100).
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Quantidade de itens a pular (paginação).
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - paid
              - expired
              - refunded
          description: Filtra as assinaturas pelo status.
      responses:
        '200':
          description: Lista paginada de assinaturas.
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscriptions:
                    type: array
                    description: Lista de assinaturas.
                    items:
                      type: object
                      properties:
                        paymentId:
                          type: string
                          description: >-
                            Identificador do pagamento da assinatura (prefixo
                            psa_sub_).
                        subscriptionId:
                          type: string
                          description: Identificador da assinatura no gateway de pagamento.
                        status:
                          type: string
                          enum:
                            - pending
                            - paid
                            - expired
                            - refunded
                          description: Status atual da assinatura.
                        amountCents:
                          type: integer
                          description: Valor de cada cobrança em centavos.
                        currency:
                          type: string
                          description: Moeda do produto (ex. "BRL").
                        productName:
                          type: string
                          description: Nome do produto vinculado à assinatura.
                        customer:
                          type: object
                          description: Dados do cliente informados na criação.
                          properties:
                            name:
                              type: string
                              description: Nome do cliente.
                            email:
                              type: string
                              description: E-mail do cliente.
                            externalId:
                              type: string
                              description: Identificador do cliente no seu sistema.
                        metadata:
                          type: string
                          description: String JSON com dados livres enviados na criação.
                        paidAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            Data e hora do último pagamento confirmado, ou null
                            se ainda não pago.
                        createdAt:
                          type: string
                          format: date-time
                          description: Data e hora de criação da assinatura.
                  total:
                    type: integer
                    description: Quantidade total de assinaturas que atendem ao filtro.
                  limit:
                    type: integer
                    description: Limite de itens por página aplicado.
                  offset:
                    type: integer
                    description: Deslocamento aplicado na paginação.
              example:
                subscriptions:
                  - paymentId: psa_sub_a1b2c3d4...
                    subscriptionId: sub_xyz...
                    status: pending
                    amountCents: 4990
                    currency: BRL
                    productName: Premium Plan
                    customer:
                      name: João Silva
                      email: ''
                      externalId: user_123
                    metadata: '{}'
                    paidAt: null
                    createdAt: '2026-03-18T10:00:00.000Z'
                total: 5
                limit: 50
                offset: 0
        '401':
          description: Chave de API inválida, ausente ou revogada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: >-
            Mensagem de erro legivel. Trate pelo codigo HTTP; o texto pode
            mudar.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

````