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

> Lista todos os planos de assinatura da sua conta.

Lista todos os planos de assinatura da sua conta.


## OpenAPI

````yaml GET /v1/subscriptions/plans
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/plans:
    get:
      tags:
        - Plano de assinaturas
      summary: Listar planos
      description: Lista todos os planos de assinatura da sua conta.
      operationId: listSubscriptionPlans
      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: plan_status
          in: query
          required: false
          schema:
            type: string
            enum:
              - ACTIVE
              - INACTIVE
      responses:
        '200':
          description: Lista de planos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionPlanListDto'
        '401':
          description: Credenciais inválidas ou ausentes
        '403':
          description: Produto `recurrency` não habilitado para o merchant
components:
  schemas:
    SubscriptionPlanListDto:
      type: array
      items:
        $ref: '#/components/schemas/SubscriptionPlanDetailDto'
    SubscriptionPlanDetailDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identificador do plano.
        name:
          type: string
          description: Nome do plano.
        description:
          type: string
          nullable: true
          description: Descrição do plano.
        amount:
          type: integer
          description: Valor do plano em centavos.
        pricing_type:
          type: string
          enum:
            - FIXED_PRICE
            - PAY_WHAT_YOU_WANT
          description: Modelo de precificação.
        currency:
          type: string
          description: Moeda ISO 4217.
        interval:
          type: string
          enum:
            - ONE_TIME
            - DAILY
            - WEEKLY
            - MONTHLY
            - QUARTERLY
            - BIANNUAL
            - ANNUAL
            - CUSTOM
          description: Cadência de cobrança.
        custom_interval:
          type: integer
          nullable: true
          description: Intervalo customizado (quando interval = CUSTOM).
        allowed_payment_types:
          type: array
          items:
            type: string
            enum:
              - credit_card
              - pix
          description: Métodos de pagamento aceitos.
        default_trial_unit:
          type: string
          enum:
            - DAY
            - WEEK
            - MONTH
            - YEAR
          nullable: true
          description: Unidade do trial padrão do plano.
        default_trial_duration:
          type: integer
          nullable: true
          description: Duração do trial padrão do plano.
        prevent_trial_abuse:
          type: boolean
          description: Se o plano bloqueia reuso de trial pelo mesmo customer.
        plan_status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          description: 'Situação do plano: ACTIVE ou INACTIVE.'
        origin:
          type: string
          enum:
            - API
            - PORTAL
          description: 'Origem da criação: API ou PORTAL.'
        created_at:
          type: string
          format: date-time
          description: Data de criação do plano.
        updated_at:
          type: string
          format: date-time
          description: Data da última atualização do plano.
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````