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

# Adaptador de Nuxt

> Añade checkout de Dodo Payments, Customer Portal y rutas de servidor para webhooks a una aplicación Nuxt 3 con el módulo @dodopayments/nuxt y la configuración de runtime.

El módulo `@dodopayments/nuxt` proporciona a tu aplicación Nuxt tres controladores de rutas de servidor. `checkoutHandler` devuelve URL de checkout, `customerPortalHandler` envía al cliente a Customer Portal y `Webhooks` verifica los eventos de webhook y los dirige a tu código.

<CardGroup cols={2}>
  <Card title="Checkout API Route" icon="cart-shopping" href="#checkout-route-handler">
    Crea URL de checkout desde una ruta de servidor de Nuxt.
  </Card>

  <Card title="Customer Portal API Route" icon="user" href="#customer-portal-route-handler">
    Permite que los clientes gestionen sus suscripciones y datos desde una ruta de servidor de Nuxt.
  </Card>

  <Card title="Webhooks API Route" icon="bell" href="#webhook-route-handler">
    Recibe y verifica eventos de webhook de Dodo Payments en Nuxt.
  </Card>
</CardGroup>

## Descripción general

<Info>
  El módulo registra sus controladores como auto-imports de servidor de Nuxt, por lo que tus rutas de servidor llaman a `checkoutHandler`, `customerPortalHandler` y `Webhooks` sin instrucciones de importación. Cada ruta lee tus credenciales desde `runtimeConfig`. Nuxt expone únicamente `runtimeConfig.public` al navegador, por lo que la clave de API y el secreto del webhook permanecen en el servidor.
</Info>

## Instalación

<Steps>
  <Step title="Install the Nuxt Module">
    Ejecuta este comando en la raíz de tu proyecto:

    ```bash theme={null}
    npm install @dodopayments/nuxt
    ```

    El módulo especifica Nuxt 3 (3.13.1 o posterior) y `zod` 3.25 o posterior como dependencias peer.
  </Step>

  <Step title="Register the Module in nuxt.config.ts">
    Añade `@dodopayments/nuxt` a tu array `modules` y asigna tus credenciales a `runtimeConfig`:

    ```typescript nuxt.config.ts expandable theme={null}
    export default defineNuxtConfig({
      modules: ["@dodopayments/nuxt"],
      devtools: { enabled: true },
      compatibilityDate: "2025-02-25",
      runtimeConfig: {
        private: {
          bearerToken: process.env.NUXT_PRIVATE_BEARER_TOKEN,
          webhookKey: process.env.NUXT_PRIVATE_WEBHOOK_KEY,
          environment: process.env.NUXT_PRIVATE_ENVIRONMENT,
          returnUrl: process.env.NUXT_PRIVATE_RETURN_URL
        },
      }
    });
    ```

    Define estas variables de entorno, por ejemplo en un archivo `.env` en la raíz de tu proyecto:

    | Variable | Valor |
    | - | - |
    | `NUXT_PRIVATE_BEARER_TOKEN` | Tu clave de API. Créala en **Developer → API Keys** en el dashboard. |
    | `NUXT_PRIVATE_WEBHOOK_KEY` | Tu secreto de webhook. Añade tu endpoint en **Developer → Webhooks** y copia su secreto de firma. |
    | `NUXT_PRIVATE_ENVIRONMENT` | `test_mode` o `live_mode`. Si no está definida, los controladores usan `live_mode`. |
    | `NUXT_PRIVATE_RETURN_URL` | Opcional. La URL a la que llegan los clientes después del checkout. |

    Un servidor Nuxt compilado no lee tu archivo `.env`. En runtime, Nuxt sobrescribe un valor de `runtimeConfig` únicamente a partir de la variable que coincide con su ruta, como `NUXT_PRIVATE_RETURN_URL` para `private.returnUrl`, así que define también estas variables en el entorno de alojamiento.
  </Step>
</Steps>

<Warning>
  Nunca confirmes tu archivo `.env` ni tus secretos en el control de versiones.
</Warning>

## Ejemplos de controladores de rutas de API

<Info>
  Los ejemplos crean rutas de servidor en el directorio `server/routes/api/`. Nuxt asigna cada archivo según su nombre y sufijo de método, por lo que `checkout.get.ts` gestiona `GET /api/checkout`.
</Info>

<Tabs>
  <Tab title="Checkout API Route">
    <Info>
      Usa este controlador para añadir checkout de Dodo Payments a tu aplicación Nuxt. Una ruta GET proporciona checkout estático. Una ruta POST proporciona sesiones de checkout o checkout dinámico cuando defines `type: "dynamic"`.
    </Info>

    Crea una ruta GET para checkout estático:

    <CodeGroup>
      ```typescript server/routes/api/checkout.get.ts expandable theme={null}
      export default defineEventHandler((event) => {
        const {
          private: { bearerToken, environment, returnUrl },
        } = useRuntimeConfig();

        const handler = checkoutHandler({
          bearerToken: bearerToken,
          environment: environment as "test_mode" | "live_mode",
          returnUrl: returnUrl,
        });

        return handler(event);
      });
      ```
    </CodeGroup>

    `checkout.post.ts` proporciona un flujo POST. Usa el ejemplo de checkout dinámico o el ejemplo de sesión de checkout:

    <CodeGroup>
      ```typescript server/routes/api/checkout.post.ts expandable theme={null}
      export default defineEventHandler((event) => {
        const {
          private: { bearerToken, environment, returnUrl },
        } = useRuntimeConfig();

        const handler = checkoutHandler({
          bearerToken: bearerToken,
          environment: environment as "test_mode" | "live_mode",
          returnUrl: returnUrl,
          type: "dynamic"
        });

        return handler(event);
      });
      ```
    </CodeGroup>

    <CodeGroup>
      ```typescript server/routes/api/checkout.post.ts (Checkout Sessions) expandable theme={null}
      export default defineEventHandler((event) => {
        const {
          private: { bearerToken, environment, returnUrl },
        } = useRuntimeConfig();

        const handler = checkoutHandler({
          bearerToken: bearerToken,
          environment: environment as "test_mode" | "live_mode",
          returnUrl: returnUrl,
          type: "session"
        });

        return handler(event);
      });
      ```
    </CodeGroup>

    <Warning>
      Si `productId` falta o no es válido, el controlador devuelve una respuesta 400.
    </Warning>

    Para probar las rutas, envía estas solicitudes:

    <CodeGroup>
      ```bash Static Checkout cURL Example theme={null}
      curl --request GET \
      --url 'https://example.com/api/checkout?productId=pdt_fqJhl7pxKWiLhwQR042rh'
      ```
    </CodeGroup>

    <CodeGroup>
      ```bash Dynamic Checkout cURL Example expandable theme={null}
      curl --request POST \
      --url https://example.com/api/checkout \
      --header 'Content-Type: application/json' \
      --data '{
      "billing": {
        "city": "Austin",
        "country": "US",
        "state": "TX",
        "street": "123 Main St",
        "zipcode": "78701"
      },
      "customer": {
        "email": "customer@example.com",
        "name": "John Doe"
      },
      "metadata": {},
      "payment_link": true,
      "product_id": "pdt_QMDuvLkbVzCRWRQjLNcs",
      "quantity": 1,
      "billing_currency": "USD",
      "discount_codes": ["IKHZ23M9GQ"],
      "return_url": "https://example.com",
      "trial_period_days": 10
      }'
      ```
    </CodeGroup>

    <CodeGroup>
      ```bash Checkout Session cURL Example expandable theme={null}
      curl --request POST \
      --url https://example.com/api/checkout \
      --header 'Content-Type: application/json' \
      --data '{
      "product_cart": [
        {
          "product_id": "pdt_QMDuvLkbVzCRWRQjLNcs",
          "quantity": 1
        }
      ],
      "customer": {
        "email": "customer@example.com",
        "name": "John Doe"
      },
      "return_url": "https://example.com/success"
      }'
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Customer Portal API Route">
    <Info>
      Crea una ruta GET que envíe a los clientes a su Customer Portal. La ruta lee `customer_id` de la cadena de consulta.
    </Info>

    <CodeGroup>
      ```typescript server/routes/api/customer-portal.get.ts expandable theme={null}
      export default defineEventHandler((event) => {
        const {
          private: { bearerToken, environment },
        } = useRuntimeConfig();

        const handler = customerPortalHandler({
          bearerToken,
          environment: environment as "test_mode" | "live_mode",
        });

        return handler(event);
      });
      ```
    </CodeGroup>

    **Parámetros de consulta:**

    * `customer_id` (obligatorio): El ID del cliente para la sesión del portal, por ejemplo `?customer_id=cus_123`.
    * `send_email` (opcional, booleano): Si `true`, Dodo Payments también envía por correo electrónico el enlace del portal al cliente.

    <Warning>
      A partir de `@dodopayments/nuxt` 0.2.11, el handler devuelve HTTP `400` si falta `customer_id` y HTTP `500` si no se puede crear la sesión del portal. Las versiones anteriores devuelven HTTP `200` en ambos casos, con un cuerpo JSON como `{ "status": 400, "body": "Missing customer_id in query parameters" }`. Para basarte en el estado HTTP, actualiza a la versión 0.2.11 o posterior.
    </Warning>

    <CodeGroup>
      ```bash Customer Portal cURL Example theme={null}
      curl --request GET \
      --url 'https://example.com/api/customer-portal?customer_id=cus_9VuW4K7O3GHwasENg31m&send_email=true'
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Webhook API Route">
    <Info>
      Crea una ruta POST para recibir eventos de webhook de Dodo Payments y verificar sus firmas.
    </Info>

    <CodeGroup>
      ```typescript server/routes/api/webhook.post.ts expandable theme={null}
      export default defineEventHandler((event) => {
        const {
          private: { webhookKey },
        } = useRuntimeConfig();

        const handler = Webhooks({
          webhookKey: webhookKey,
          onPayload: async (payload: any) => {
            // Handle webhook payload here
          },
          // ...add other event handlers as needed
        });

        return handler(event);
      });
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Controlador de rutas de checkout

El controlador de checkout admite las tres formas de aceptar pagos con Dodo Payments:

* **Enlaces de pago estáticos:** URL que se pueden compartir y que cobran pagos sin código.
* **Enlaces de pago dinámicos:** Enlaces de pago que generas con datos personalizados. Usan endpoints obsoletos.
* **Sesiones de checkout:** Checkout alojado con carrito de productos, datos del cliente y opciones de personalización. Este es el flujo recomendado.

`checkoutHandler` acepta estas opciones:

| Opción | Tipo | Descripción |
| - | - | - |
| `bearerToken` | `string` | Tu clave de API de Dodo Payments. |
| `environment` | `string` | `test_mode` o `live_mode`. Su valor predeterminado es `live_mode`. |
| `returnUrl` | `string` | Opcional. La URL a la que checkout redirige al cliente después del pago. Un `return_url` en un cuerpo POST tiene prioridad. |
| `type` | `string` | Opcional. En una ruta GET, déjalo sin definir o establécelo en `static`, porque otros valores hacen que el checkout estático devuelva 400. En una ruta POST, `dynamic` selecciona checkout dinámico, y cualquier otro valor, o ninguno, selecciona sesiones de checkout. |

<AccordionGroup>
  <Accordion title="Static Checkout (GET)">
    ### Parámetros de consulta compatibles

    <ParamField query="productId" type="string" required>
      Identificador del producto, por ejemplo `?productId=pdt_nZuwz45WAs64n3l07zpQR`.
    </ParamField>

    <ParamField query="quantity" type="integer" default="1">
      Cantidad del producto.
    </ParamField>

    <ParamField query="fullName" type="string">
      Nombre completo del cliente. Se ignora si se proporciona `firstName` o `lastName`.
    </ParamField>

    <ParamField query="firstName" type="string">
      Nombre del cliente.
    </ParamField>

    <ParamField query="lastName" type="string">
      Apellido del cliente.
    </ParamField>

    <ParamField query="email" type="string">
      Dirección de correo electrónico del cliente.
    </ParamField>

    <ParamField query="country" type="string">
      País del cliente, como código alpha-2 ISO 3166-1.
    </ParamField>

    <ParamField query="addressLine" type="string">
      Línea de dirección del cliente.
    </ParamField>

    <ParamField query="city" type="string">
      Ciudad del cliente.
    </ParamField>

    <ParamField query="state" type="string">
      Estado o provincia del cliente.
    </ParamField>

    <ParamField query="zipCode" type="string">
      Código ZIP o postal del cliente.
    </ParamField>

    <ParamField query="disableFullName" type="boolean">
      Establécelo en `true` para desactivar el campo de nombre completo.
    </ParamField>

    <ParamField query="disableFirstName" type="boolean">
      Establécelo en `true` para desactivar el campo de nombre.
    </ParamField>

    <ParamField query="disableLastName" type="boolean">
      Establécelo en `true` para desactivar el campo de apellido.
    </ParamField>

    <ParamField query="disableEmail" type="boolean">
      Establécelo en `true` para desactivar el campo de correo electrónico.
    </ParamField>

    <ParamField query="disableCountry" type="boolean">
      Establécelo en `true` para desactivar el campo de país.
    </ParamField>

    <ParamField query="disableAddressLine" type="boolean">
      Establécelo en `true` para desactivar el campo de línea de dirección.
    </ParamField>

    <ParamField query="disableCity" type="boolean">
      Establécelo en `true` para desactivar el campo de ciudad.
    </ParamField>

    <ParamField query="disableState" type="boolean">
      Establécelo en `true` para desactivar el campo de estado.
    </ParamField>

    <ParamField query="disableZipCode" type="boolean">
      Establécelo en `true` para desactivar el campo de código ZIP.
    </ParamField>

    <ParamField query="paymentCurrency" type="string">
      Moneda del pago, por ejemplo `USD`.
    </ParamField>

    <ParamField query="showCurrencySelector" type="boolean" default="true">
      Muestra u oculta el selector de moneda.
    </ParamField>

    <ParamField query="paymentAmount" type="number">
      Fija el importe cobrado, en unidades principales de moneda, por ejemplo `12.5` para \$12.50. Solo funciona con productos Pay What You Want y se ignora si está por debajo del precio mínimo del producto.
    </ParamField>

    <ParamField query="showDiscounts" type="boolean" default="true">
      Muestra u oculta la sección de descuentos.
    </ParamField>

    <ParamField query="metadata_*" type="string">
      Cualquier parámetro de consulta que comience con `metadata_` se pasa como metadatos.
    </ParamField>

    El controlador añade `returnUrl` de su configuración al enlace como `redirect_url`.

    <Warning>
      Si `productId` falta, el controlador devuelve una respuesta 400. Los parámetros de consulta no válidos y los ID de producto inexistentes también devuelven 400.
    </Warning>

    ### Formato de respuesta

    El checkout estático devuelve una respuesta JSON con la URL de checkout. En modo de prueba, la URL usa `test.checkout.dodopayments.com`.

    ```json theme={null}
    {
      "checkout_url": "https://checkout.dodopayments.com/..."
    }
    ```
  </Accordion>

  <Accordion title="Dynamic Checkout (POST)">
    * Envía los parámetros como cuerpo JSON en una solicitud POST.
    * Admite pagos únicos y recurrentes.
    * `billing` e `customer` son obligatorios.
    * Para consultar todos los campos de cuerpo compatibles, consulta:
      * [Cuerpo de solicitud para un producto de pago único](https://docs.dodopayments.com/api-reference/payments/post-payments)
      * [Cuerpo de solicitud para un producto de suscripción](https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions)

    <Warning>
      El checkout dinámico actúa como proxy de los endpoints obsoletos `POST /payments` y `POST /subscriptions`. Sigue funcionando para integraciones existentes, pero las integraciones nuevas deben usar sesiones de checkout.
    </Warning>

    ### Formato de respuesta

    El checkout dinámico devuelve una respuesta JSON con la URL de checkout:

    ```json theme={null}
    {
      "checkout_url": "https://checkout.dodopayments.com/..."
    }
    ```
  </Accordion>

  <Accordion title="Checkout Sessions (POST)">
    Las sesiones de checkout crean un checkout alojado para compras únicas y suscripciones, con control total sobre la personalización. `product_cart` es el único campo obligatorio. Si el cuerpo no contiene `return_url`, el controlador usa `returnUrl` de su configuración.

    Para obtener más detalles y consultar todos los campos compatibles, visita la [Guía de integración de Checkout Sessions](https://docs.dodopayments.com/developer-resources/checkout-session).

    Una sesión creada con `payment_method_id` no devuelve ninguna URL de checkout, por lo que el controlador responde con 400. Para cobrar con un método de pago guardado, crea la sesión con el SDK.

    ### Formato de respuesta

    Las sesiones de checkout devuelven una respuesta JSON con la URL de checkout:

    ```json theme={null}
    {
      "checkout_url": "https://checkout.dodopayments.com/session/..."
    }
    ```
  </Accordion>
</AccordionGroup>

## Controlador de rutas de Customer Portal

El controlador de rutas de Customer Portal crea una sesión de Customer Portal para el cliente que proporciones y redirige el navegador a ella.

<Warning>
  El controlador no comprueba quién realiza la llamada. Cualquiera que lo solicite con un ID de cliente obtiene el portal de ese cliente. Protege la ruta con tu propia autenticación y pasa únicamente el ID de cliente del usuario que ha iniciado sesión.
</Warning>

### Parámetros de consulta

<ParamField query="customer_id" type="string" required>
  El ID del cliente para la sesión del portal, por ejemplo `?customer_id=cus_123`.
</ParamField>

<ParamField query="send_email" type="boolean">
  Si se establece en `true`, Dodo Payments también envía por correo electrónico el enlace del portal al cliente.
</ParamField>

<Warning>
  A partir de `@dodopayments/nuxt` 0.2.11, el handler devuelve HTTP `400` si falta `customer_id` y HTTP `500` si no se puede crear la sesión del portal. Las versiones anteriores devuelven HTTP `200` en ambos casos, con un cuerpo JSON como `{ "status": 400, "body": "Missing customer_id in query parameters" }`. Para basarte en el estado HTTP, actualiza a la versión 0.2.11 o posterior.
</Warning>

## Controlador de rutas de webhook

El controlador de rutas de webhook verifica cada solicitud antes de ejecutar tu código:

* **Método:** Solo se admiten solicitudes POST. Otros métodos devuelven 405.
* **Verificación de firma:** Verifica el cuerpo de la solicitud sin procesar y los encabezados `webhook-id`, `webhook-timestamp` y `webhook-signature` con `webhookKey`, siguiendo la especificación de [Standard Webhooks](https://standardwebhooks.com/). Devuelve 401 si la verificación falla.
* **Validación de payload:** Valida el payload con Zod. Devuelve 400 si el payload no es válido.
* **Gestión de errores:**
  * 401: Firma no válida
  * 400: Payload no válido
  * 500: Error interno durante la verificación
* **Enrutamiento de eventos:** Llama a `onPayload` para cada evento, después al controlador correspondiente al tipo de evento y devuelve 200.

El adaptador no captura los errores generados en tus controladores. Estos se propagan a Nuxt y la solicitud falla.

### Controladores de eventos de webhook compatibles

Cada controlador recibe el payload verificado correspondiente a su tipo de evento:

<CodeGroup>
  ```typescript TypeScript expandable theme={null}
  onPayload?: (payload: WebhookPayload) => Promise<void>;
  onPaymentSucceeded?: (payload: WebhookPayload) => Promise<void>;
  onPaymentFailed?: (payload: WebhookPayload) => Promise<void>;
  onPaymentProcessing?: (payload: WebhookPayload) => Promise<void>;
  onPaymentCancelled?: (payload: WebhookPayload) => Promise<void>;
  onRefundSucceeded?: (payload: WebhookPayload) => Promise<void>;
  onRefundFailed?: (payload: WebhookPayload) => Promise<void>;
  onDisputeOpened?: (payload: WebhookPayload) => Promise<void>;
  onDisputeExpired?: (payload: WebhookPayload) => Promise<void>;
  onDisputeAccepted?: (payload: WebhookPayload) => Promise<void>;
  onDisputeCancelled?: (payload: WebhookPayload) => Promise<void>;
  onDisputeChallenged?: (payload: WebhookPayload) => Promise<void>;
  onDisputeWon?: (payload: WebhookPayload) => Promise<void>;
  onDisputeLost?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionActive?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionOnHold?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionRenewed?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionPlanChanged?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionCancelled?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionFailed?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionExpired?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionUpdated?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionPaused?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionUnpaused?: (payload: WebhookPayload) => Promise<void>;
  onSubscriptionUpdatePaymentMethod?: (payload: WebhookPayload) => Promise<void>;
  onLicenseKeyCreated?: (payload: WebhookPayload) => Promise<void>;
  onAbandonedCheckoutDetected?: (payload: WebhookPayload) => Promise<void>;
  onAbandonedCheckoutRecovered?: (payload: WebhookPayload) => Promise<void>;
  onDunningStarted?: (payload: WebhookPayload) => Promise<void>;
  onDunningRecovered?: (payload: WebhookPayload) => Promise<void>;
  onCreditAdded?: (payload: WebhookPayload) => Promise<void>;
  onCreditDeducted?: (payload: WebhookPayload) => Promise<void>;
  onCreditExpired?: (payload: WebhookPayload) => Promise<void>;
  onCreditRolledOver?: (payload: WebhookPayload) => Promise<void>;
  onCreditRolloverForfeited?: (payload: WebhookPayload) => Promise<void>;
  onCreditOverageCharged?: (payload: WebhookPayload) => Promise<void>;
  onCreditOverageReset?: (payload: WebhookPayload) => Promise<void>;
  onCreditManualAdjustment?: (payload: WebhookPayload) => Promise<void>;
  onCreditBalanceLow?: (payload: WebhookPayload) => Promise<void>;
  onEntitlementGrantCreated?: (payload: WebhookPayload) => Promise<void>;
  onEntitlementGrantDelivered?: (payload: WebhookPayload) => Promise<void>;
  onEntitlementGrantFailed?: (payload: WebhookPayload) => Promise<void>;
  onEntitlementGrantRevoked?: (payload: WebhookPayload) => Promise<void>;
  onPayoutCreated?: (payload: WebhookPayload) => Promise<void>;
  onPayoutOnHold?: (payload: WebhookPayload) => Promise<void>;
  onPayoutInProgress?: (payload: WebhookPayload) => Promise<void>;
  onPayoutFailed?: (payload: WebhookPayload) => Promise<void>;
  onPayoutSuccess?: (payload: WebhookPayload) => Promise<void>;
  ```
</CodeGroup>

Para saber qué significa cada evento, consulta la [Guía de eventos de webhook](/developer-resources/webhooks/intents/webhook-events-guide).

***

## Prompt para LLM

Copia este prompt en tu asistente de programación con IA para que añada el módulo a tu proyecto. Para proporcionar también a tu agente la documentación y las skills de Dodo Payments, instala el [Agent Plugin](/developer-resources/build-with-ai-coding-agents).

```text expandable theme={null}
You are an expert Nuxt developer assistant. Your task is to guide a user through integrating the @dodopayments/nuxt module into their existing Nuxt project.

The @dodopayments/nuxt module provides API route handlers for Dodo Payments' Checkout, Customer Portal, and Webhook functionalities, designed for Nuxt 3 server routes. The module auto-imports checkoutHandler, customerPortalHandler, and Webhooks into server routes, so the route files need no import statements.

First, install the necessary package:

npm install @dodopayments/nuxt

Second, add the configuration to nuxt.config.ts

export default defineNuxtConfig({
  modules: ["@dodopayments/nuxt"],
  devtools: { enabled: true },
  compatibilityDate: "2025-02-25",
  runtimeConfig: {
    private: {
      bearerToken: process.env.NUXT_PRIVATE_BEARER_TOKEN,
      webhookKey: process.env.NUXT_PRIVATE_WEBHOOK_KEY,
      environment: process.env.NUXT_PRIVATE_ENVIRONMENT,
      returnUrl: process.env.NUXT_PRIVATE_RETURN_URL
    },
  }
});

Here's how you should structure your response:

    Ask the user which functionalities they want to integrate.

"Which parts of the @dodopayments/nuxt module would you like to integrate into your project? You can choose one or more of the following:

    Checkout API Route (for handling product checkouts)
    Customer Portal API Route (for managing customer subscriptions/details)
    Webhook API Route (for receiving Dodo Payments webhook events)
    All (integrate all three)"

    Based on the user's selection, provide detailed integration steps for each chosen functionality.

If Checkout API Route is selected:

Purpose: This route returns a JSON response with a checkout_url for the Dodo Payments checkout page.
File Creation: Create a new file at server/routes/api/checkout.get.ts in your Nuxt project.

Code Snippet:

// server/routes/api/checkout.get.ts

export default defineEventHandler((event) => {
  const {
    private: { bearerToken, environment, returnUrl },
  } = useRuntimeConfig();

  const handler = checkoutHandler({
    bearerToken: bearerToken,
    environment: environment as "test_mode" | "live_mode",
    returnUrl: returnUrl,
  });

  return handler(event);
});

Configuration & Usage:
- bearerToken: Your Dodo Payments API key. Set via the NUXT_PRIVATE_BEARER_TOKEN environment variable.
- returnUrl: (Optional) The URL to redirect the user to after a successful checkout.
- environment: (Optional) "test_mode" or "live_mode". Defaults to "live_mode".
- type: (Optional) On a POST route (server/routes/api/checkout.post.ts), set "dynamic" for dynamic checkout or "session" for checkout sessions. Any value other than "dynamic" serves checkout sessions.

Static Checkout (GET) Query Parameters:
- productId (required): Product identifier (e.g., ?productId=pdt_nZuwz45WAs64n3l07zpQR)
- quantity (optional): Quantity of the product
- Customer Fields (optional): fullName, firstName, lastName, email, country, addressLine, city, state, zipCode
- Disable Flags (optional, set to true to disable): disableFullName, disableFirstName, disableLastName, disableEmail, disableCountry, disableAddressLine, disableCity, disableState, disableZipCode
- Advanced Controls (optional): paymentCurrency, showCurrencySelector, paymentAmount, showDiscounts
- Metadata (optional): Any query parameter starting with metadata_ (e.g., ?metadata_userId=abc123)

Dynamic Checkout (POST): Parameters are sent as a JSON body. Supports both one-time and recurring payments. For a complete list of supported POST body fields, refer to:
- Docs - One Time Payment Product: https://docs.dodopayments.com/api-reference/payments/post-payments
- Docs - Subscription Product: https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions

Checkout Sessions (POST) - (Recommended) A more customizable checkout experience. Returns JSON with checkout_url: Parameters are sent as a JSON body, and product_cart is required. Supports both one-time and recurring payments. Returns: {"checkout_url": "https://checkout.dodopayments.com/session/..."}. For a complete list of supported fields, refer to:

  Checkout Sessions Integration Guide: https://docs.dodopayments.com/developer-resources/checkout-session

Error Handling: If productId is missing or other query parameters are invalid, the handler will return a 400 response.

If Customer Portal API Route is selected:

Purpose: This route redirects a customer to their Dodo Payments customer portal. It does not authenticate the caller, so protect the route and pass only the signed-in user's customer ID.
File Creation: Create a new file at server/routes/api/customer-portal.get.ts in your Nuxt project.

Code Snippet:

// server/routes/api/customer-portal.get.ts

export default defineEventHandler((event) => {
  const {
    private: { bearerToken, environment },
  } = useRuntimeConfig();

  const handler = customerPortalHandler({
    bearerToken,
    environment: environment as "test_mode" | "live_mode",
  });

  return handler(event);
});

Query Parameters:
- customer_id (required): The customer ID for the portal session (e.g., ?customer_id=cus_123)
- send_email (optional, boolean): If set to true, sends an email to the customer with the portal link.
- Returns 400 if customer_id is missing, and 500 if the portal session cannot be created (@dodopayments/nuxt 0.2.11 or later).

If Webhook API Route is selected:

Purpose: This route processes incoming webhook events from Dodo Payments, allowing your application to react to events like successful payments, refunds, or subscription changes.
File Creation: Create a new file at server/routes/api/webhook.post.ts in your Nuxt project.

Code Snippet:

// server/routes/api/webhook.post.ts

export default defineEventHandler((event) => {
  const {
    private: { webhookKey },
  } = useRuntimeConfig();

  const handler = Webhooks({
    webhookKey: webhookKey,
    onPayload: async (payload) => {
      // handle the payload
    },
    // ... other event handlers for granular control
  });

  return handler(event);
});

Handler Details:
- Method: Only POST requests are supported. Other methods return 405.
- Signature Verification: The handler verifies the webhook signature using webhookKey and returns 401 if verification fails.
- Payload Validation: The payload is validated with Zod. Returns 400 for invalid payloads.

Error Handling:
- 401: Invalid signature
- 400: Invalid payload
- 500: Internal error during verification

Event Routing: Calls onPayload for every event, then the handler for the event's type. Supported event handlers include:
- onPayload?: (payload: WebhookPayload) => Promise<void>
- onPaymentSucceeded?: (payload: WebhookPayload) => Promise<void>
- onPaymentFailed?: (payload: WebhookPayload) => Promise<void>
- onPaymentProcessing?: (payload: WebhookPayload) => Promise<void>
- onPaymentCancelled?: (payload: WebhookPayload) => Promise<void>
- onRefundSucceeded?: (payload: WebhookPayload) => Promise<void>
- onRefundFailed?: (payload: WebhookPayload) => Promise<void>
- onDisputeOpened?: (payload: WebhookPayload) => Promise<void>
- onDisputeExpired?: (payload: WebhookPayload) => Promise<void>
- onDisputeAccepted?: (payload: WebhookPayload) => Promise<void>
- onDisputeCancelled?: (payload: WebhookPayload) => Promise<void>
- onDisputeChallenged?: (payload: WebhookPayload) => Promise<void>
- onDisputeWon?: (payload: WebhookPayload) => Promise<void>
- onDisputeLost?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionActive?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionOnHold?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionRenewed?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionPlanChanged?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionCancelled?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionFailed?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionExpired?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionUpdated?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionPaused?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionUnpaused?: (payload: WebhookPayload) => Promise<void>
- onSubscriptionUpdatePaymentMethod?: (payload: WebhookPayload) => Promise<void>
- onLicenseKeyCreated?: (payload: WebhookPayload) => Promise<void>
- onAbandonedCheckoutDetected?: (payload: WebhookPayload) => Promise<void>
- onAbandonedCheckoutRecovered?: (payload: WebhookPayload) => Promise<void>
- onDunningStarted?: (payload: WebhookPayload) => Promise<void>
- onDunningRecovered?: (payload: WebhookPayload) => Promise<void>
- onCreditAdded?: (payload: WebhookPayload) => Promise<void>
- onCreditDeducted?: (payload: WebhookPayload) => Promise<void>
- onCreditExpired?: (payload: WebhookPayload) => Promise<void>
- onCreditRolledOver?: (payload: WebhookPayload) => Promise<void>
- onCreditRolloverForfeited?: (payload: WebhookPayload) => Promise<void>
- onCreditOverageCharged?: (payload: WebhookPayload) => Promise<void>
- onCreditOverageReset?: (payload: WebhookPayload) => Promise<void>
- onCreditManualAdjustment?: (payload: WebhookPayload) => Promise<void>
- onCreditBalanceLow?: (payload: WebhookPayload) => Promise<void>
- onEntitlementGrantCreated?: (payload: WebhookPayload) => Promise<void>
- onEntitlementGrantDelivered?: (payload: WebhookPayload) => Promise<void>
- onEntitlementGrantFailed?: (payload: WebhookPayload) => Promise<void>
- onEntitlementGrantRevoked?: (payload: WebhookPayload) => Promise<void>
- onPayoutCreated?: (payload: WebhookPayload) => Promise<void>
- onPayoutOnHold?: (payload: WebhookPayload) => Promise<void>
- onPayoutInProgress?: (payload: WebhookPayload) => Promise<void>
- onPayoutFailed?: (payload: WebhookPayload) => Promise<void>
- onPayoutSuccess?: (payload: WebhookPayload) => Promise<void>

Environment Variable Setup:
To ensure the module functions correctly, set up the following environment variables in your Nuxt project's deployment environment (e.g., Vercel, Netlify, AWS, etc.). A built Nuxt server does not read the .env file, and Nuxt overrides runtime config values at runtime only from variables whose names match the config path:
- NUXT_PRIVATE_BEARER_TOKEN: Your Dodo Payments API Key (required for Checkout and Customer Portal).
- NUXT_PRIVATE_WEBHOOK_KEY: Your Dodo Payments Webhook Secret (required for Webhook handler).
- NUXT_PRIVATE_ENVIRONMENT: (Optional) "test_mode" or "live_mode". Defaults to "live_mode".
- NUXT_PRIVATE_RETURN_URL: (Optional) The URL to redirect to after a successful checkout (for Checkout handler).

Usage in your code:
bearerToken: useRuntimeConfig().private.bearerToken
webhookKey: useRuntimeConfig().private.webhookKey

Important: Never commit sensitive environment variables directly into your version control. Use environment variables for all sensitive information.

If the user needs assistance setting up environment variables for their specific deployment environment, ask them what platform they are using (e.g., Vercel, Netlify, AWS, etc.), and provide guidance.
```


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