WPSubscription Pro incluye soporte para API REST para realizar acciones de suscripción de forma programática. Esta función permite a los desarrolladores y herramientas de automatización gestionar suscripciones de forma remota utilizando solicitudes de API seguras.

Configuración de API

Para habilitar y acceder a la funcionalidad de API REST:

  1. Ve a WPSubscription > Configuración > Configuración de API

  2. Marca Habilitar puntos finales de API REST para acciones de suscripción

  3. Copia la URL del punto final de API REST proporcionada

  4. Usa o regenera la Clave de API para autenticación

Mantén tu clave de API segura. Debe incluirse en cada solicitud de API.
Captura de pantalla de 2025-06-02 16-13-57.png

Acciones de Suscripción Disponibles

Cada solicitud de API debe realizarse como una solicitud POST a:

/wp-json/wpsubscription/v1/action

Cada solicitud debe incluir:

  • action: Tipo de operación a realizar (por ejemplo, cancel_subscription)

  • subscription_id: ID de la suscripción a la que se dirige

  • api_key: Tu clave de API generada por el plugin

  • data: Información adicional opcional (por ejemplo, motivo de la cancelación)

Acciones Soportadas

Acción

Descripción

Ejemplo de Caso de Uso

cancel_subscription

Cancela una suscripción activa

Disparar desde CRM cuando el cliente se da de baja

pause_subscription

Pone una suscripción en espera (pendiente)

Pausa por vacaciones o problema de pago

resume_subscription

Reactiva una suscripción pausada

Reanudar la facturación después de la pausa

change_status

Cambiar estado a: activo, pendiente, cancelado, expirado

Sincronizar con sistema externo o regla de administrador

reactivate_subscription

Reactivar una suscripción cancelada

Anulación manual desde soporte o CRM

expire_subscription

Marcar la suscripción como expirada manualmente

Planes limitados en el tiempo o forzar expiración

trial_end

Disparar lógica personalizada al final del período de prueba gratuito

Convertir de gratuito a pagado en otros sistemas

payment_failed

Registrar o reaccionar a intentos de renovación fallidos

Flujos de trabajo de cobro, alerta de CRM

verify_api

Verificar la validez de la clave de API

Probar conexión desde herramienta externa

Solicitud JSON de Ejemplo

Captura de pantalla de 2025-06-02 16-14-17.png

Así es como reanudar una suscripción a través de Postman o un sistema externo:

POST /wp-json/wpsubscription/v1/action
{
  "action": "resume_subscription",
  "subscription_id": 168,
  "api_key": "your-api-key",
  "data": {
    "reason": "Solicitud del cliente"
  }
}

Respuesta de éxito de JSON de ejemplo

{
  "status": "success",
  "message": "Acción de suscripción \"resume_subscription\" procesada con éxito",
  "subscription_id": 168
}

Registros y depuración

Toda la actividad de la API REST se registra dentro de WooCommerce > Estado > Registros bajo el archivo de registro llamado subscription-pro-api-YYYY-MM-DD.

Captura de pantalla de 2025-06-02 16-13-36.png

Cada registro incluye:

  • Marca de tiempo

  • Tipo de acción

  • ID de suscripción

  • Estado (procesado o error)

  • Datos de carga útil (si los hay)

Autenticación y seguridad

  • Todas las llamadas a la API requieren la clave de API para acceder.

  • Las claves de API se pueden regenerar en cualquier momento desde la configuración de la API.

  • Las claves deben almacenarse de forma segura y no exponerse en solicitudes públicas.

Manejo de errores

Las respuestas REST devolverán códigos de error apropiados para entradas no válidas o estados de falla.

Código de error

Significado

rest_forbidden

Clave de API no válida o faltante

not_found

ID de suscripción no encontrado

invalid_status

El valor de estado proporcionado no es válido

action_failed

Fallo general de la acción

Siempre verifica que el cuerpo de tu solicitud incluya:

  • Clave de API válida

  • Nombre de acción correcto

  • ID de suscripción válido