> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtén un plan de suscripción

Localpayment proporciona un endpoint para obtener información detallada sobre los planes de suscripción existentes. Esta guía explica cómo obtener los detalles de los planes de suscripción a través de la API de Localpayment, lo que te permite verificar las configuraciones del plan, comprobar su estado y utilizar la información del plan en tu aplicación.

## Antes de comenzar

Asegúrate de tener:

> [card] [Credenciales de API](https://docs.localpayment.com/es/docs/api-keys-and-environments.md)
>
> Credenciales API válidas y token de acceso para la autenticación.

> [card] [Configuración de la cuenta](https://docs.localpayment.com/es/docs/make-your-first-test-payment.md)
>
> Configuración adecuada de la cuenta para el país de destino y verificación de la empresa.

> [card] [Lista blanca de IP](https://docs.localpayment.com/es/docs/dashboard-whitelist-your-ips.md)
>
> Incluye en la lista blanca las direcciones IP de tus servidores para el acceso a la API.

> [card] [Endpoint del webhook](https://docs.localpayment.com/es/docs/webhooks.md)
>
> Configura una URL de webhook para recibir notificaciones de pago.

***

## Paso 1: Obtén los detalles del plan de suscripción.

Para obtener la información de un plan de suscripción, envía una solicitud `GET` al endpoint [Obtén un plan de suscripción](https://docs.localpayment.com/es/docs/get-subscription-plan.md).

### Parámetros clave de la solicitud

La solicitud requiere varios parámetros clave:

| Parámetro | Descripción | Requerido |
| - | - | - |
| `internalId` | Identificador único del plan de Localpayment de la ruta URL | ✅ |

### Ejemplo de solicitud

A continuación se muestra un ejemplo que utiliza `curl`:

```bash curl theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
curl --request GET \
  --url 'https://api.stage.localpayment.com/api/subscriptions/plan/{internalId}' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <your_access_token>' \
  --header 'Content-Type: application/json'
```

Consulta todos los [parámetros disponibles](https://docs.localpayment.com/es/docs/get-subscription-plan.md) en la solicitud.

***

## Paso 2: Gestionar la respuesta

### Respuesta exitosa

Una solicitud exitosa devuelve los detalles completos del plan de suscripción:

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
    "internalId": "b8546575-5d4f-4a56-9e21-522d01cf5992",
    "name": "Plan Básico Mensual",
    "description": "Acceso básico a contenido exclusivo",
    "amount": 50,
    "country": "MEX",
    "currency": "MXN",
    "accountNumber": "{{accountNumber}}",
    "autoRecurring": {
        "repetitions": 1,
        "type": "hour",
        "frequency": 1
    },
    "status": {
        "code": "100",
        "description": "ACTIVE",
        "detail": "Subscription plan is active"
    }
}
```

### Campos de respuesta clave

| Parámetro | Descripción | Caso de uso |
| - | - | - |
| `internalId` | Identificador único del plan de Localpayment. | Referencia para operaciones de API. |
| `name` | Nombre descriptivo del plan de suscripción. | Mostrar a los clientes. |
| `description` | Explicación detallada de las características del plan. | Comunicación con el cliente. |
| `amount` | Importe de la factura. | Procesamiento de pagos. |
| `country` | País donde el plan está disponible. | Restricciones geográficas. |
| `currency` | Moneda de facturación. | Cálculos financieros. |
| `accountNumber` | Número de cuenta comercial asociado. | Reconciliación. |
| `autoRecurring.type` | Tipo de frecuencia de facturación. | Gestión del ciclo de facturación. |
| `autoRecurring.repetitions` | Número de ciclos de facturación. | Seguimiento de la duración del plan. |
| `autoRecurring.frequency` | Valor de frecuencia de facturación. | Configuración de facturación recurrente. |
| `status.code` | Código de estado del plan actual. | Comprobación de disponibilidad. |

### Respuesta de error

Cuando no se pueda encontrar o acceder a un plan de suscripción, recibirás información de error:

```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
{
  "status": {
    "code": "400",
    "description": "ERROR",
    "detail": "Plan subscription not found"
  }
}
```

***

## Paso 3: Seguimiento del estado de la transacción

Tras recuperar un plan de suscripción, podrás comprobar su disponibilidad y estado actual:

> [card] [Webhooks (recomendado)](https://docs.localpayment.com/es/docs/webhooks.md)
>
> Recibe notificaciones en tiempo real cuando cambie el estado de la transacción. Más eficiente para entornos de producción.

> [card] [Endpoint de la API de estado](https://docs.localpayment.com/es/reference/get-transaction-status.md)
>
> Consulta el estado de las transacciones mediante programación. Útil para sondear o recuperar notificaciones de webhook perdidas.

> [card] [Vista del Business Portal](https://docs.localpayment.com/es/docs/dashboard-overview.md)
>
> Interfaz visual para el seguimiento de transacciones. Ideal para la supervisión manual y el análisis detallado de las transacciones.

### Códigos de estado comunes

| Código | Estado | Descripción |
| :- | :- | :- |
| `100` | `ACTIVE` | El plan está activo y disponible para asociaciones suscriptoras. |
| `400` | `REJECTED` | La recuperación del plan falló debido a parámetros no válidos o a que no se encontró el plan. |

> [!NOTE]
>
> **Referencia completa**
>
> Consulta todos los códigos de estado en nuestra [documentación sobre el estado de las transacciones](https://docs.localpayment.com/es/reference/transaction-status-error-codes).

***

## Probando tu integración

### Escenarios de prueba

Verifica que tu integración gestione estos escenarios:

1. **Recuperación exitosa del plan**: Obtén los detalles de un plan activo existente.
2. **Plan inexistente**: Intentar recuperar un plan que no existe.
3. **ID de plan no válido**: Prueba con formatos internalId incorrectos o mal formados.
4. **Fallos de autenticación**: Recuperar planes con tokens de acceso no válidos o caducados.

***

## Próximos pasos

> [card] [Crea un plan de suscripción](https://docs.localpayment.com/es/docs/create-a-subscription-plan.md)
>
> Configura nuevos planes de suscripción para diferentes niveles de servicio o modelos de precios.

> [card] [Actualizar plan de suscripción](https://docs.localpayment.com/es/docs/update-a-subscription-plan.md)
>
> Modifica los detalles del plan existente en función de la información obtenida.

> [card] [Crear suscripción con plan](https://docs.localpayment.com/es/docs/create-a-subscription.md)
>
> Utiliza el ID del plan para crear nuevas suscripciones de clientes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.