> ## 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.

# Consultar assinatura

> Retorna os detalhes de uma assinatura.

Retorna os detalhes de uma assinatura.


## OpenAPI

````yaml GET /v1/subscriptions/{subscriptionId}
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/{subscriptionId}:
    get:
      tags:
        - Assinaturas
      summary: Consultar assinatura
      description: Retorna os detalhes de uma assinatura.
      operationId: getSubscription
      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: subscriptionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Detalhe da assinatura
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionDetailDto'
        '401':
          description: Credenciais inválidas ou ausentes
        '403':
          description: Produto `recurrency` não habilitado para o merchant
        '404':
          description: Assinatura não encontrada
components:
  schemas:
    SubscriptionDetailDto:
      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 (congelado do plano na criação).
        currency:
          type: string
          description: Moeda ISO 4217 da assinatura.
        grace_period_days:
          type: integer
          nullable: true
          description: Dias de tolerância após falha de cobrança.
        grace_ends_at:
          type: string
          format: date-time
          nullable: true
          description: Fim da janela de carência após falha de cobrança.
        trial_unit:
          type: string
          enum:
            - DAY
            - WEEK
            - MONTH
            - YEAR
          nullable: true
          description: Unidade do trial da assinatura.
        trial_duration:
          type: integer
          nullable: true
          description: Duração do trial da assinatura.
        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.
        cancellation_reason:
          type: string
          nullable: true
          description: 'Motivo do cancelamento: USER_ACTION ou PAYMENT_FAILED.'
        cancelled_at:
          type: string
          format: date-time
          nullable: true
          description: Data do cancelamento.
        plan:
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanSummaryDto'
          description: Resumo do plano da assinatura.
        customer:
          allOf:
            - $ref: '#/components/schemas/SubscriptionCustomerSummaryDto'
          description: Resumo do cliente da assinatura.
        payment_method:
          type: object
          nullable: true
          allOf:
            - $ref: '#/components/schemas/SubscriptionPaymentMethodSummaryDto'
          description: Método de pagamento padrão 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.
    SubscriptionPaymentMethodSummaryDto:
      oneOf:
        - type: object
          required:
            - type
            - id
            - last_four
            - first_six
          properties:
            type:
              type: string
              enum:
                - card
              description: Método de pagamento cartão.
            id:
              type: string
              format: uuid
              description: Identificador do método de pagamento.
            last_four:
              type: string
              example: '1111'
              description: Últimos 4 dígitos do cartão.
            first_six:
              type: string
              example: '411111'
              description: Primeiros 6 dígitos (BIN) do cartão.
        - type: object
          required:
            - type
            - id
          properties:
            type:
              type: string
              enum:
                - pix
              description: Método de pagamento PIX.
            id:
              type: string
              format: uuid
              description: Identificador do método de pagamento.
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````