Pular para o conteúdo principal

API de créditos

Endpoints de consulta de saldo, seleção de plano e assinatura. O modelo de consumo está documentado em Créditos.

Consultar saldo

GET /credits

Resposta:

{
"plan": "creator",
"credits": 245,
"totalCredits": 300
}
CampoDescrição
planPlano ativo: free, creator, pro, enterprise
creditsSaldo disponível no ciclo atual
totalCreditsTotal de créditos do ciclo

Selecionar plano

POST /credits/select-plan

Body:

{
"plan": "pro"
}

Resposta: { "status": "ok", "plan": "pro" }

Checkout Stripe

POST /stripe/checkout

Cria uma sessão de checkout para contratação ou upgrade de plano.

Body:

{
"plan": "pro",
"frequency": "monthly"
}
CampoValores
plancreator, pro
frequencymonthly, yearly

Resposta:

{
"url": "https://checkout.stripe.com/..."
}

Redirecione o usuário para a url retornada. Ao concluir o pagamento, o Stripe devolve o usuário ao aplicativo e o plano é ativado imediatamente.

Portal do cliente

POST /stripe/customer-portal

Cria uma sessão do portal do cliente Stripe, onde o usuário gerencia faturas, método de pagamento e cancelamento.

Resposta:

{
"url": "https://billing.stripe.com/..."
}

Regras do modelo

  • 1 crédito = 1 minuto de vídeo processado;
  • Renovação no início de cada ciclo de faturamento, sem acúmulo;
  • Planos pagos incluem bônus de boas-vindas;
  • Enterprise: créditos ilimitados;
  • O saldo é validado no servidor ao criar cada projeto — ver Erros e convenções.

Próximos passos: Créditos (guia) · Planos e preços