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

# Consultar assinatura

> Retorna a assinatura, os dados do cliente e o histórico das últimas 20 cobranças.

Retorna os dados da assinatura, do cliente e o histórico das últimas 20 cobranças (`pagamentos`).

<Info>
  Visão conceitual e significado de cada `status` em [Guias › Assinaturas](/guias/assinaturas).
</Info>


## OpenAPI

````yaml GET /v1/subscriptions/{subscriptionId}
openapi: 3.0.3
info:
  title: API Ephra
  description: >-
    API REST para gerar cobranças (PIX, cartão e boleto), consultar transações e
    gerenciar webhooks.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security:
  - bearerAuth: []
tags:
  - name: Autenticação
    description: Login e obtenção do token de acesso
  - name: Pagamentos
    description: Criação de cobranças PIX, cartão e boleto
  - name: Assinaturas
    description: Cobrança recorrente — iniciar, listar, consultar e cancelar assinaturas
  - name: Transações
    description: Consulta de transações
  - name: Webhooks
    description: Cadastro e gerenciamento de webhooks
paths:
  /v1/subscriptions/{subscriptionId}:
    get:
      tags:
        - Assinaturas
      summary: Consultar assinatura
      description: >-
        Retorna a assinatura, os dados do cliente e o histórico das últimas 20
        cobranças.
      operationId: getSubscription
      parameters:
        - name: subscriptionId
          in: path
          required: true
          schema:
            type: string
          example: clx_sub_123
      responses:
        '200':
          description: Detalhe da assinatura
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionDetailResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Assinatura não encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                success: false
                message: Assinatura não encontrada.
components:
  schemas:
    SubscriptionDetailResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            id:
              type: string
              example: clx_sub_123
            assinatura:
              type: object
              properties:
                dataDeInicio:
                  type: string
                  example: '2026-07-11T12:00:00.000Z'
                status:
                  type: string
                  enum:
                    - active
                    - overdue
                    - cancelled
                    - completed
                    - failed
                  example: active
                statusLabel:
                  type: string
                  example: Ativo
                acessoRemovidoEm:
                  type: string
                  nullable: true
                  example: null
                tipo:
                  type: string
                  example: Cursos
                produto:
                  type: string
                  example: Curso Premium
                plano:
                  type: string
                  example: Plano Mensal Premium
                valorLiquidoInCents:
                  type: integer
                  example: 34900
                parcelas:
                  type: integer
                  nullable: true
                  example: null
                frequencia:
                  type: string
                  example: Mensal
                cobrancasAprovadas:
                  type: integer
                  example: 3
                dataDoCancelamento:
                  type: string
                  nullable: true
                  example: null
            cliente:
              type: object
              properties:
                id:
                  type: string
                  example: cust_1
                nome:
                  type: string
                  example: Maria Silva
                email:
                  type: string
                  format: email
                  example: maria@exemplo.com
                celular:
                  type: string
                  example: '11999998888'
                documento:
                  type: string
                  example: '52998224725'
                tipoDocumento:
                  type: string
                  enum:
                    - cpf
                    - cnpj
                  example: cpf
            pagamentos:
              type: array
              description: Histórico das últimas 20 cobranças.
              items:
                type: object
                properties:
                  id:
                    type: string
                    example: clx_tx_777
                  data:
                    type: string
                    example: '2026-09-11T12:00:00.000Z'
                  status:
                    type: string
                    example: paid
                  valorLiquidoInCents:
                    type: integer
                    example: 34900
                  valorBrutoInCents:
                    type: integer
                    example: 34900
    Error:
      type: object
      properties:
        statusCode:
          type: integer
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: Mensagem descritiva do erro
  responses:
    Unauthorized:
      description: Token ausente, inválido ou expirado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 401
            error: Unauthorized
            message: Token inválido ou expirado
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````