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

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

​
Corpo da requisição

CampoTipoObrigatórioDescrição
namestring✅Nome do plano exibido ao assinante
amountCentsinteger✅Valor em centavos (mínimo 500 = R$ 5,00)
intervalstring✅MONTHLY, QUARTERLY, SEMIANNUAL ou ANNUAL
descriptionstringDescrição opcional do plano
trialDaysintegerDias de período de trial gratuito
maxSubscribersintegerLimite de assinantes (null = ilimitado)

​
Exemplo

curl --request POST \
  --url https://alpa-sistema-api.onrender.com/api/subscriptions/plans \
  --header 'Authorization: Bearer SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Plano Mensal Premium",
    "description": "Acesso completo com suporte prioritário",
    "amountCents": 9900,
    "interval": "MONTHLY",
    "trialDays": 7
  }'

const response = await fetch('https://alpa-sistema-api.onrender.com/api/subscriptions/plans', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.ALPA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Plano Mensal Premium',
    description: 'Acesso completo com suporte prioritário',
    amountCents: 9900,
    interval: 'MONTHLY',
    trialDays: 7,
  }),
});
const { data } = await response.json();

​
Resposta de sucesso (201 Created)

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Plano Mensal Premium",
    "description": "Acesso completo com suporte prioritário",
    "amountCents": 9900,
    "interval": "MONTHLY",
    "trialDays": 7,
    "maxSubscribers": null,
    "active": true,
    "createdAt": "2026-05-25T00:00:00.000Z"
  }
}

​
Próximos passos

Listar planos

Consulte todos os planos criados.

Checkout público

Inscreva seu primeiro cliente.