Pular para o conteúdo principal

Introdução

Venda acesso ao seu produto como uma assinatura paga recorrente.

🔐 Os métodos deste módulo requerem autorização.

Mais informações sobre a interface do usuário do módulo https://doc.oneentry.cloud/docs/category/subscriptions

🎯 O que este módulo faz?​

O módulo Assinaturas permite que você gerencie assinaturas pagas para o usuário atual — crie uma assinatura e receba uma sessão de pagamento, cancele-a, recupere-a através do Portal de Faturamento da Stripe e liste os marcadores de assinatura disponíveis ou ativos.

Em vez de pedidos únicos, um usuário se inscreve em um plano (um marcador como premium) e é cobrado automaticamente pelo provedor de pagamento.

🚀 Início Rápido​

Inicialize o módulo a partir de defineOneEntry:


const { Subscriptions } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Inscreva o usuário atual em um plano e redirecione-o para a sessão de pagamento (autenticação necessária):

// Create a subscription for the "premium" plan.
const session = await Subscriptions.subscribe({ marker: "premium" });

// Send the user to the payment page to complete the first payment.
window.location.href = session.paymentUrl;

✨ Conceitos Chave​

O que é um marcador de assinatura?​

Um marcador é o identificador de texto único de um plano de assinatura (por exemplo, premium). Você o passa para cada método deste módulo para informar ao OneEntry qual plano você está se referindo. Os marcadores nunca mudam, então sempre faça referência aos planos pelo marcador em seu código.

Sessão de pagamento​

subscribe() retorna uma sessão de pagamento (ICreatedSubscription) — um objeto com um paymentUrl que o usuário deve abrir para completar o primeiro pagamento. Redirecione o usuário para lá para finalizar a compra.

📋 O que você precisa saber​

📊 Tabela de Referência Rápida​

MétodoDescrição
subscribe() 🔐Crie uma assinatura e obtenha uma sessão de pagamento
getAllSubscriptions() 🔐Obtenha todos os marcadores de assinatura disponíveis
getActiveSubscriptions() 🔐Obtenha marcadores das assinaturas ativas do usuário
cancelSubscription() 🔐Cancele uma assinatura
recoverSubscriptions() 🔐Recupere uma assinatura via o Portal de Faturamento

🔐 = Requer autorização

❓ Perguntas Comuns (FAQ)​

Como eu crio um plano de assinatura?​

Os planos de assinatura são configurados no painel de administração do OneEntry e conectados a uma conta de pagamento (por exemplo, Stripe). O SDK referencia cada plano pelo seu marcador.

O que subscribe() retorna?​

Ele retorna uma sessão de pagamento com um paymentUrl. Redirecione o usuário para esse URL para completar o primeiro pagamento e ativar a assinatura.

Qual é a diferença entre cancelar e recuperar?​

cancelSubscription() interrompe a cobrança recorrente de um plano. recoverSubscriptions() restaura uma assinatura previamente cancelada através do Portal de Faturamento da Stripe.

🎓 Melhores Práticas​

  • Sempre faça referência aos planos pelo marcador, nunca por um nome de exibição.
  • Autentique o usuário antes de chamar qualquer método de assinatura.
  • Após subscribe(), redirecione o usuário para paymentUrl e trate a URL de retorno em seu aplicativo.
  • Use getActiveSubscriptions() para restringir recursos premium em sua interface.

🔗 Documentação Relacionada​