javoscript/laravel-mercadopago-prepaid-subscriptions

This package is abandoned and no longer maintained. No replacement package was suggested.

A prepaid subscriptions package for the Laravel framework implemented with MercadoPago as the payment method.

Maintainers

Details

github.com/javoscript/laravel-mercadopago-prepaid-subscriptions

Source

Issues

Installs: 38

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 3

Forks: 1

Open Issues: 1

v0.3.3 2019-06-10 16:03 UTC

Requires

Requires (Dev)

MIT 9e44186598f1d36cc928520e24272e36bb466a8b

  • Javier Ugarte <javougarte.woop@gmail.com>

This package is auto-updated.

Last update: 2024-10-21 11:03:00 UTC

README

Dado que la sección sobre suscripciones (o pagos recurrentes) fue removida recientemente de la documentación de MercadoPago para desarrolladores, fue necesario crear una alternativa.

La funcionalidad de este paquete no es exactamente igual a la de las suscripciones típicas. En cambio, provee la lógica necesaria para implementar suscripciones prepagas dentro de una aplicación desarrollada en Laravel.

¿Qué NO son las suscripciones prepagas?

No son el típico concepto de suscripción que utilizamos frecuentemente, donde uno se suscribe a un servicio o producto y paga un monto fijo cada cierto período de tiempo.

Ese modelo de pagos lo ofrece MercadoPago, pero la documentación de la API para poder integrar un sistema externo fue removida de la página para developers.

¿Qué SÍ son las suscripciones prepagas?

Tal vez sea más fácil de entender alrededor del concepto de fecha de vencimiento. La implementación de este paquete funciona de la siguiente forma:

  • Un modelo se asocia a una cuenta de suscripción (account)
  • En el momento en que se registra esta asociación, se le asigna una fecha de vencimiento (expiration_date). Esta fecha de vencimiento inicial dependerá del valor configurable del free trial.
  • La suscripción estará activa siempre que la fecha de vencimiento de la cuenta sea posterior a la fecha actual.
  • Se ofrece la posibilidad de extender esta fecha de vencimiento con la compra de planes (configurables). Estos planes extienden la fecha de vencimiento por un período de tiempo a un precio.
  • Se pueden comprar múltiples planes de forma consecutiva, extendiendo aún más la fecha de vencimiento.

Ejemplo

  • Un usuario crea una nueva cuenta el 1-ene-2019
  • El free trial se encuentra configurado por 7 días. Por lo tanto, la fecha de vencimiento se asigna al 8-ene-2019

Situación inicial:

  • Los planes configurados son:
  • El usuario compra el plan de 1 mes, por lo que su cuenta quedará:
  • El usuario compra el plan de 12 meses, por lo que su cuenta quedará:

  • Si el usuario siguiera comprando planes, seguiría extendiendo su fecha de vencimiento (más allá de que no fuera necesario).

  • Si el usuario no comprara más planes, su cuenta recién quedaría inhabilitada el 7-feb-2019. Hasta ese día su suscripción se encuentra activa.

Instalación

Para instalar el paquete con composer:

composer require javoscript/laravel-mercadopago-prepaid-subscriptions

Correr las migraciones para generar las tablas necesarias en la base de datos:

php artisan migrate

Publicar la configuración

php artisan vendor:publish --provider="Javoscript\PrepaidSubs\PrepaidSubsServiceProvider" --tag=config

(Opcional) Publicar las vistas para customizarlas

php artisan vendor:publish --provider="Javoscript\PrepaidSubs\PrepaidSubsServiceProvider" --tag=views

Configuración

Variables de entorno

Agregar las variables de entorno en el archivo .env:

MP_PUBLIC_KEY=
MP_ACCESS_TOKEN=
MP_SANDBOX_PUBLIC_KEY=
MP_SANDBOX_ACCESS_TOKEN=

Estas se pueden obtener de MercadoPago.

Configuración del paquete

Luego de publicar el archivo de configuración, se pueden editar los parámetros configurables en config/prepaid-subs.php. Estas variables son:

service_name

Indica el nombre del servicio que se está vendiendo. Se enviará en la descripción de la compra por MercadoPago.

route_prefix

Indica el prefijo que se usarán para las rutas utilizadas por el paquete.

Valor por defecto: "prepaid-subs"

free_trial

Indica el período que se ofrecerá como free trial.

Valor por defecto: "7 days"

Esta opción acepta strings con el mismo formato que la función add() del paquete Carbon\Carbon. Ver Documentación.

Algunos ejemplos válidos:

  • "1 week"
  • "3 weeks"
  • "2 months"
  • "1 year"

sandbox_mode

Indica si la integración con MercadoPago se realiza en modo de prueba.

Valor por defecto: true

Cuando esta variable tenga el valor true, se podrá obervar el cartelito de Sandbox Mode al proceder al pago con MercadoPago.

![alt text](./docs/sandbox_mode.png "MercadoPago sandbox mode")

Integración con MercadoPago en modo de prueba (*sandbox mode*)

plans

Indica los planes que ofrecerá el paquete. Se debe respetar el formato del array que se vé en el ejemplo.

    "plans" => [
        [
            "name" => "1 mes",
            "time_value" => 1,
            "time_unit" => "month",
            "price" => 99,
            "old_price" => null,
            "details" => [
                "El más básico, sólo un mes",
                "Sin ahorros",
                "Sin riesgos",
                "Para probar el producto"
            ]
        ],
        [
            "name" => "3 meses",
            "time_value" => 3,
            "time_unit" => "month",
            "price" => 199,
            "old_price" => 300,
            "details" => [
                "Para quien piensa a mediano plazo, tres meses",
                "Quiero probarlo, y quiero ahorrar",
            ]
        ],
        [
            "name" => "12 meses",
            "time_value" => 12,
            "time_unit" => "month",
            "price" => 999,
            "old_price" => 1200,
            "details" => []
        ],
    ]
  • name indica el nombre del plan
  • time_value y time_unit indican el período de tiempo que se extenderá la fecha de vencimiento al comprar ese plan
  • price indica el precio en pesos argentinos (ARS)
  • old_price indica el precio anterior (o sin descuento)
  • details es un array de strings que contiene características del plan

Todos estos valores estarán disponibles para usar en donde sea necesario en el código a través de objetos de la clase Javoscript\PrepaidSubs\PrepaidPlan (ver más adelante).

![alt text](./docs/plans_partial.png "Included default plans partials")

`partial` inlcuido con el paquete: formulario con datos necesarios y elección de plan.

Uso

TODO: add image

Estructura general

TODO: completar

Facade

TODO: completar

Cuentas

TODO: completar

Planes

TODO: completar

Trait

(Opcional) El paquete incluye un Trait que se puede agregar a los modelos que se quieran relacionar con las cuentas de suscripciones TODO: completar

Views

El paquete incluye dos vistas a modo de ejemplo para la implementación del lado del frontend.

Planes

TODO: compoletar

Payments

TODO: completar

Cómo sobreescribir las vistas de callback

  • Success
  • Failure
  • Pending

Compra de un plan

Licencia

MIT License (MIT). Ver Licencia para más información.