Ir al contenido

Grupos (Products)

Ver .md

Los grupos son el paso inicial y opcional para organizar tus suscripciones: te permiten agrupar planes relacionados y darles orden. Un grupo puede contener varios planes (precios).

Son ideales cuando manejas varios negocios o productos distintos: creas un grupo por cada uno y asocias sus planes al grupo correspondiente.

Descripción: Devuelve todos tus grupos.

GET /api/v1/subscriptions/group

GEThttps://sag.efipay.co/api/v1/subscriptions/group
Ventana de terminal
curl -X GET \
'/api/v1/subscriptions/group' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Accept: application/json'
200OK
[
{
"id": "9b0f2a13-2c44-4a1a-9f2e-1d3b4c5d6e7f",
"name": "Streaming",
"description": "Planes de streaming",
"active": true,
"user_id": 42,
"office_id": 1,
"commerce_id": 315,
"created_at": "2026-07-31 10:15:00"
}
]

Es el mismo alias en el listado: GET /api/v1/subscriptions/product devuelve exactamente esto.

GEThttps://sag.efipay.co/api/v1/subscriptions/product

Descripción: Crea un grupo con nombre y sucursal. Opcionalmente puedes darle una description.

POST /api/v1/subscriptions/group

Nombre del campo Descripción Reglas
name Nombre del grupo. Lo verás al organizar tus planes. No puede repetirse dentro de tu comercio ['required', 'string', 'max:255', 'unique:subscription_groups,name']
description Para qué es el grupo. Solo de uso interno ['nullable', 'string', 'max:500']
office Sucursal a la que pertenece el grupo. Debe ser una de tus sucursales ['required', 'exists:offices,id']
POSThttps://sag.efipay.co/api/v1/subscriptions/group
Ventana de terminal
curl -X POST \
'/api/v1/subscriptions/group' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-type: application/json' \
-H 'Idempotency-Key: 9b1f0e34-6b2a-4a7e-9d0a-000000000001' \
-d '{
"name": "Streaming",
"description": "Planes de streaming",
"office": 1
}'
200OK
{
"saved": true,
"group": {
"id": "9b0f2a13-2c44-4a1a-9f2e-1d3b4c5d6e7f",
"name": "Streaming",
"description": "Planes de streaming",
"plansCount": 0,
"createdAt": "2026-07-31 10:15:00"
}
}
422Unprocessable Entity
{
"message": "El campo name ya está en uso.",
"errors": {
"name": ["El campo name ya está en uso."],
"office": ["El office seleccionado no es válido."]
}
}

Descripción: Cambia el nombre o la descripción del grupo. El nuevo nombre no puede repetirse dentro de tu comercio. La sucursal del grupo no se puede cambiar.

PUT /api/v1/subscriptions/group/{group-id}

Nombre del campo Descripción Reglas
name Nuevo nombre. Único dentro de tu comercio, ignorando este mismo grupo ['required', 'string', 'max:255', 'unique:subscription_groups,name']
description Nueva descripción. Envía null para borrarla ['sometimes', 'nullable', 'string', 'max:500']
PUThttps://sag.efipay.co/api/v1/subscriptions/group/your-group-id
Ventana de terminal
curl -X PUT \
'/api/v1/subscriptions/group/9b0f2a13-2c44-4a1a-9f2e-1d3b4c5d6e7f' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-type: application/json' \
-d '{
"name": "Streaming",
"description": "Planes de streaming mensual"
}'
200OK
{
"saved": true,
"group": {
"id": "9b0f2a13-2c44-4a1a-9f2e-1d3b4c5d6e7f",
"name": "Streaming",
"description": "Planes de streaming mensual",
"plansCount": 3,
"createdAt": "2026-07-31 10:15:00"
}
}
403Forbidden

Descripción: Elimina un grupo por su id.

DELETE /api/v1/subscriptions/group/{group-id}

DELETEhttps://sag.efipay.co/api/v1/subscriptions/group/your-group-id
Ventana de terminal
curl -X DELETE \
'/api/v1/subscriptions/group/9b0f2a13-2c44-4a1a-9f2e-1d3b4c5d6e7f' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Accept: application/json'
200OK
{
"deleted": true
}
400Bad Request
{
"deleted": false,
"message": "El grupo tiene planes asociados y no puede eliminarse."
}

Las mismas operaciones, con el nombre de Stripe. Comportamiento, parámetros y respuestas son idénticos a los de arriba.

Crear — POST /api/v1/subscriptions/product

POSThttps://sag.efipay.co/api/v1/subscriptions/product

Actualizar — PUT /api/v1/subscriptions/product/{product-id}

PUThttps://sag.efipay.co/api/v1/subscriptions/product/your-group-id

Eliminar — DELETE /api/v1/subscriptions/product/{product-id}

DELETEhttps://sag.efipay.co/api/v1/subscriptions/product/your-group-id

Última actualización: