Skip to main content

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.

​
Endpoint

GET /api/subscriptions/plans
Autenticação: API Key (Authorization: Bearer SUA_API_KEY)

​
Parâmetros de query

ParâmetroTipoPadrãoDescrição
pageinteger1Página da listagem
limitinteger20Itens por página (máximo 100)

​
Exemplo

curl --request GET \
  --url 'https://alpa-sistema-api.onrender.com/api/subscriptions/plans?page=1&limit=20' \
  --header 'Authorization: Bearer SUA_API_KEY'

​
Resposta de sucesso (200 OK)

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Plano Mensal Premium",
      "amountCents": 9900,
      "interval": "MONTHLY",
      "trialDays": 7,
      "maxSubscribers": null,
      "active": true,
      "createdAt": "2026-05-25T00:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 3,
    "totalPages": 1
  }
}

​
Métricas dos planos

Para consultar MRR, churn rate e assinantes ativos, use o endpoint de métricas: 
curl --request GET \
  --url https://alpa-sistema-api.onrender.com/api/subscriptions/metrics \
  --header 'Authorization: Bearer SUA_API_KEY'

{
  "success": true,
  "data": {
    "mrr": 99000,
    "activeSubscribers": 42,
    "churnRate": 0.048
  }
}

Criar plano

Adicione um novo plano de assinatura.