Descripción: Trae Todas las suscripciones.
Descripción: trae una suscripción por su "id".
Descripción: Trae una lista de suscripciones a partir de un plan.
Descripción: Trae una lista de las suscripciones de un usuario.
Descripción: Con este método podrás crear una suscripción a partir de un plan y subscriptor previamente creados, junto con la información de la tarjeta a utilizar, para poder realizar el cobro automático de la recurrencia, se tokenizara la tarjeta enviada, en caso de que nos envies el token generado por nosotros de la tarjeta usaremos ese token para los cobros.
| Nombre del campo | Descripción | Reglas |
|---|---|---|
| plan_id | Hace referencia al ID de tu plan | requerido, existe, donde el registro no ha sido eliminado, el campo 'commerce_id' y 'office_id' deben pertenecer al mismo plan, limitando los resultados a un determinado lugar de sucursal |
| subscriber_id | Es una cadena, hace referencia a la ID del suscriptor | requerido, existe, donde el registro no ha sido eliminado, 'subscriber_id' debe existir en tu comercio y tus sucursales disponibles, restringiendo los resultados a un determinado lugar de sucursal |
| card | Es una cadena tipo token, hace referencia al token creado en tokenizado. Es requerido si 'card_information' no está presente en la solicitud, ambos no pueden estar presentes al mismo tiempo en la solicitud | ausente con card_information, requerido sin:card_information, cadena |
| card_information.holder | Obligatorio si 'card' no está presente en la solicitud, y debe ser una cadena con una longitud máxima de 80 caracteres. No puede estar presente en la solicitud si 'card' está presente | ausente con card, a veces, requerido, cadena, max:80 |
| card_information.number | Obligatorio si 'card' no está presente en la solicitud, y debe ser un número de tarjeta de crédito válido. No puede estar presente en la solicitud si 'card' está presente | ausente con card, a veces, requerido, número de tarjeta |
| card_information.datetime | Obligatorio si 'card' no está presente en la solicitud, y debe ser una fecha válida en el formato yyyy-mm. No puede estar presente en la solicitud si 'card' está | ausente con card, a veces, requerido, fecha de expiración |
| card_information.cvv | Obligatorio si 'card' no está presente en la solicitud, y debe ser un código CVV de tarjeta de crédito válido. No puede estar presente en la solicitud si 'card' está presente | ausente con card, a veces, requerido, entero, o CVV de la tarjeta de crédito` |
| webhook_url | Descripción: Servicio que envía datos en tiempo real con la transacción realizada. | Puede ser nulo, debe ser una URL, la ruta debe ser tipo POST, usa un token que viene por la cabecera de Signature |
| office | Debe pertenecer a una sucursal existente | Si la ruta de la solicitud empieza con 'api/', el campo es requerido, de otra forma puede ser nulo. La tabla 'offices' y la columna 'id' deben existir. El 'id' debe estar presente dentro de la lista de 'id' asociados a las sucursales del usuario autenticado. |
Solicitud con token
curl -X POST\
'{{ URL::to('/api/v1/subscriptions/subscription') }}'\
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H "Content-type: application/json" \
-d '{
"plan_id": "9a9331d9-ea9a-4ad4-a9a4-0d23bd91fff1",
"subscriber_id": "9a933275-1573-497c-916c-ba7fe4f99326",
"card": "your-token-card-here",
"office": 1
}'Ejemplo de solicitud sin token:
curl -X POST\
'{{ URL::to('/api/v1/subscriptions/subscription') }}'\
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H "Content-type: application/json" \
-d '{
"plan_id": "9a9331d9-ea9a-4ad4-a9a4-0d23bd91fff1",
"subscriber_id": "9a933275-1573-497c-916c-ba7fe4f99326",
"card_information": {
"holder": "Holder Holder",
"number": "5249314023340339",
"datetime": "2026-02",
"cvv": 899
},
"office": 1
}'Descripción: Cancela una suscripción activa.