Saltar al contenido principal

Introducción

Vende acceso a tu producto como una suscripción paga recurrente.

🔐 Los métodos de este módulo requieren autorización.

Más información sobre la interfaz de usuario del módulo https://doc.oneentry.cloud/docs/category/subscriptions

🎯 ¿Qué hace este módulo?​

El módulo de Suscripciones te permite gestionar suscripciones pagas para el usuario actual: crear una suscripción y recibir una sesión de pago, cancelarla, recuperarla a través del Portal de Facturación de Stripe y listar los marcadores de suscripción disponibles o activos.

Piénsalo como facturación recurrente para tu aplicación: en lugar de pedidos únicos, un usuario se suscribe a un plan (un "marcador" como premium) y se le factura automáticamente por el proveedor de pagos.

📖 Explicación Simple​

Un flujo de suscripción generalmente se ve así:

  • 🧾 Planes - Defines los planes de suscripción (marcadores) en el panel de administración de OneEntry
  • 💳 Suscribirse - El usuario elige un plan y es redirigido a una sesión de pago
  • 🔁 Facturación recurrente - El proveedor de pagos cobra al usuario automáticamente
  • ❌ Cancelar - El usuario cancela y mantiene el acceso hasta que finalice el período
  • ♻️ Recuperar - El usuario restaura una suscripción cancelada a través del Portal de Facturación

✨ Conceptos Clave​

¿Qué es un marcador de suscripción?​

Un marcador es el identificador de texto único de un plan de suscripción (por ejemplo, premium). Lo pasas a cada método de este módulo para indicarle a OneEntry a qué plan te refieres. Los marcadores nunca cambian, así que siempre referencia los planes por marcador en tu código.

Sesión de pago​

subscribe() devuelve una sesión de pago: un objeto con un paymentUrl que el usuario debe abrir para completar el primer pago. Redirige al usuario allí para finalizar la compra.

📋 Lo Que Necesitas Saber​

  • Todos los métodos requieren un usuario autorizado: llámalos después de que el usuario haya iniciado sesión a través del módulo AuthProvider.
  • getAllSubscriptions() devuelve todos los marcadores disponibles, getActiveSubscriptions() devuelve solo los marcadores a los que el usuario actual está suscrito.
  • cancelSubscription() y recoverSubscriptions() resuelven a true en caso de éxito.

📊 Tabla de Referencia Rápida​

MétodoDescripción
subscribe()Crea una suscripción y obtiene una sesión de pago
getAllSubscriptions()Obtiene todos los marcadores de suscripción disponibles
getActiveSubscriptions()Obtiene los marcadores de las suscripciones activas del usuario
cancelSubscription()Cancela una suscripción
recoverSubscriptions()Recupera una suscripción a través del Portal de Facturación

❓ Preguntas Comunes (FAQ)​

¿Cómo creo un plan de suscripción?​

Los planes de suscripción se configuran en el panel de administración de OneEntry y se conectan a una cuenta de pago (por ejemplo, Stripe). El SDK hace referencia a cada plan por su marcador.

¿Qué devuelve subscribe()?​

Devuelve una sesión de pago con un paymentUrl. Redirige al usuario a esa URL para completar el primer pago y activar la suscripción.

¿Cuál es la diferencia entre cancelar y recuperar?​

cancelSubscription() detiene la facturación recurrente para un plan. recoverSubscriptions() restaura una suscripción previamente cancelada a través del Portal de Facturación de Stripe.

🎓 Mejores Prácticas​

  • Siempre referencia los planes por marcador, nunca por un nombre de visualización.
  • Autentica al usuario antes de llamar a cualquier método de suscripción.
  • Después de subscribe(), redirige al usuario a paymentUrl y maneja la URL de retorno en tu aplicación.
  • Usa getActiveSubscriptions() para restringir características premium en tu interfaz de usuario.

Definición del módulo de Suscripciones​


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

🔗 Documentación Relacionada​