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.

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.

🚀 Inicio Rápido​

Inicializa el módulo desde defineOneEntry:


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

Suscribe al usuario actual a un plan y redirígelo a la sesión de pago (se requiere autenticación):

// 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;

✨ 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 indicar 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 (ICreatedSubscription) — 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​

📊 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

🔐 = Requiere autorizació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 de 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.

🔗 Documentación Relacionada​