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

# Criar plano

> Crie um plano de assinatura recorrente via API



## OpenAPI

````yaml POST /api/subscriptions/plans
openapi: 3.0.3
info:
  title: Alpa Gateway API
  version: 2.30.0
  description: >-
    Documentação completa da API pública do Alpa Gateway (v2.23.0). Todas as
    rotas requerem autenticação via API Key, exceto validação de cupom, checkout
    público e checkout de assinaturas. Novidades em 2.23.0: sistema de
    assinaturas recorrentes com planos, retry automático e métricas MRR/churn;
    cart abandonment para recuperação de vendas.
  contact:
    email: suporte@usealpa.com
  license:
    name: MIT
servers:
  - url: https://alpa-sistema-api.onrender.com
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Transações
    description: Gerenciamento de transações de pagamento
  - name: Links de Pagamento
    description: Gerenciamento de links de pagamento
  - name: Produtos
    description: Gerenciamento de produtos do catálogo
  - name: Cupons
    description: Gerenciamento de cupons de desconto
  - name: Webhooks
    description: Gerenciamento de webhooks e assinaturas
  - name: Saldo
    description: Consulta de saldo e movimentações
  - name: Clientes
    description: Gerenciamento de clientes
  - name: Afiliados
    description: Marketplace de afiliados, links rastreáveis e comissões automáticas
  - name: Assinaturas
    description: Planos de assinatura recorrente, checkout público e métricas MRR/churn
  - name: Saques
    description: Solicitações de saque, saldo disponível e métodos de retirada
  - name: Antecipações
    description: Antecipação de recebíveis de transações de cartão parceladas
  - name: Indicações
    description: >-
      Programa de indicações — código de convite, estatísticas e histórico de
      recompensas
paths:
  /api/subscriptions/plans:
    post:
      tags:
        - Assinaturas
      summary: Criar plano
      description: Cria um novo plano de assinatura recorrente
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionPlanRequest'
      responses:
        '201':
          description: Plano criado com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/SubscriptionPlan'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKeyAuth: []
components:
  schemas:
    CreateSubscriptionPlanRequest:
      type: object
      required:
        - name
        - amountCents
        - interval
      properties:
        name:
          type: string
          example: Plano Mensal Premium
        description:
          type: string
          example: Acesso completo com suporte prioritário
        amountCents:
          type: integer
          minimum: 500
          example: 9900
          description: Valor em centavos (mínimo R$ 5,00)
        interval:
          type: string
          enum:
            - MONTHLY
            - QUARTERLY
            - SEMIANNUAL
            - ANNUAL
          example: MONTHLY
        trialDays:
          type: integer
          minimum: 0
          example: 7
        maxSubscribers:
          type: integer
          minimum: 1
          nullable: true
    SubscriptionPlan:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Plano Mensal
        description:
          type: string
          nullable: true
        amountCents:
          type: integer
          description: Valor da cobrança em centavos
          example: 9900
        interval:
          type: string
          enum:
            - MONTHLY
            - QUARTERLY
            - SEMIANNUAL
            - ANNUAL
          example: MONTHLY
        trialDays:
          type: integer
          nullable: true
          description: Dias de período de trial
          example: 7
        maxSubscribers:
          type: integer
          nullable: true
          description: Limite de assinantes (null = ilimitado)
        active:
          type: boolean
          example: true
        createdAt:
          type: string
          format: date-time
  responses:
    BadRequest:
      description: Requisição inválida
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              timestamp:
                type: string
                format: date-time
              path:
                type: string
              errors:
                type: array
                items:
                  type: object
    Unauthorized:
      description: Não autorizado - API Key inválida ou ausente
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: API-Key
      description: >-
        Chave de API obtida através do endpoint /api/credentials. Também aceita
        formato Bearer Token: Authorization: Bearer <api_key>

````