> ## 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 Astro

> Añade checkout de Dodo Payments, Customer Portal y endpoints de webhook a un proyecto de Astro con el paquete @dodopayments/astro.

El paquete `@dodopayments/astro` proporciona a tu proyecto de Astro tres controladores de endpoint. `Checkout` devuelve URLs de checkout, `CustomerPortal` envía al cliente al Customer Portal y `Webhooks` verifica los eventos de webhook y los dirige a tu código.

<CardGroup cols={2}>
  <Card title="Checkout Handler" icon="cart-shopping" href="#checkout-route-handler">
    Crea URLs de checkout con flujos estáticos, dinámicos y de checkout session.
  </Card>

  <Card title="Customer Portal" icon="user" href="#customer-portal-route-handler">
    Permite que los clientes gestionen sus suscripciones y datos.
  </Card>

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

## Instalación

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

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

    El paquete declara Astro 4 o 5 y `zod` 3.25 o posterior como peer dependencies.
  </Step>

  <Step title="Set Up Environment Variables">
    Crea un archivo `.env` en la raíz de tu proyecto. Crea la API key en **Developer → API Keys**. Añade tu endpoint de webhook en **Developer → Webhooks** y copia su **Signing secret** en `DODO_PAYMENTS_WEBHOOK_KEY`:

    ```env expandable theme={null}
    DODO_PAYMENTS_API_KEY=your-api-key
    DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
    # test_mode or live_mode
    DODO_PAYMENTS_ENVIRONMENT=test_mode
    DODO_PAYMENTS_RETURN_URL=https://yourdomain.com/checkout/success
    ```

    `DODO_PAYMENTS_RETURN_URL` es el destino de los clientes después del checkout. Si no pasas un entorno, los controladores usan `live_mode`. Una API key de test mode funciona únicamente con `test_mode`.

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

## Ejemplos de Route Handler

<Info>
  Los ejemplos son endpoints de servidor de Astro en `src/pages/api/`. Los endpoints que llaman a Dodo Payments deben renderizarse bajo demanda, así que añade un server adapter a tu proyecto de Astro. En el modo de salida predeterminado `static` de Astro, los endpoints se renderizan en tiempo de compilación; por eso cada ejemplo exporta `prerender = false` para renderizar el endpoint en cada solicitud.
</Info>

<Tabs>
  <Tab title="Checkout Handler">
    <Info>
      Usa este controlador para añadir el checkout de Dodo Payments a tu aplicación. El controlador `GET` ofrece checkout estático. El controlador `POST` ofrece checkout sessions o checkout dinámico cuando configuras `type: "dynamic"`. Un archivo de endpoint solo puede exportar un controlador `POST`, por lo que el ejemplo de checkout dinámico supone que configuras `type: "dynamic"`.
    </Info>

    <CodeGroup>
      ```typescript Astro Route Handler expandable theme={null}
      // src/pages/api/checkout.ts
      import { Checkout } from "@dodopayments/astro";

      export const prerender = false;

      export const GET = Checkout({
          bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
          returnUrl: import.meta.env.DODO_PAYMENTS_RETURN_URL,
          environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
          type: "static", // optional, defaults to 'static'
      });

      export const POST = Checkout({
          bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
          returnUrl: import.meta.env.DODO_PAYMENTS_RETURN_URL,
          environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
          type: "session", // for checkout sessions, or "dynamic" for dynamic checkout
      });
      ```
    </CodeGroup>

    <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 Handler">
    <Info>
      Usa este controlador para enviar a los clientes al Customer Portal de Dodo Payments, donde pueden gestionar sus suscripciones y datos.
    </Info>

    <CodeGroup>
      ```typescript Astro Route Handler expandable theme={null}
      // src/pages/api/customer-portal.ts
      import { CustomerPortal } from "@dodopayments/astro";

      export const prerender = false;

      export const GET = CustomerPortal({
          bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
          environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
      });
      ```
    </CodeGroup>

    <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 Handler">
    <Info>
      Usa este controlador para recibir eventos de webhook de Dodo Payments en tu aplicación de Astro y verificar sus firmas.
    </Info>

    <CodeGroup>
      ```typescript Astro Route Handler expandable theme={null}
      // src/pages/api/webhook.ts
      import { Webhooks } from "@dodopayments/astro";

      export const prerender = false;

      export const POST = Webhooks({
          webhookKey: import.meta.env.DODO_PAYMENTS_WEBHOOK_KEY,
          onPayload: async (payload) => {
              // handle the payload
          },
          // ... other event handlers for granular control
      });
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Checkout Route Handler

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

* **Static Payment Links:** URLs compartibles que recaudan pagos sin código.
* **Dynamic Payment Links:** enlaces de pago que generas con datos personalizados. Utilizan endpoints obsoletos.
* **Checkout Sessions:** checkout alojado con carrito de productos, datos del cliente y opciones de personalización. Este es el flujo recomendado.

`Checkout` acepta estas opciones:

| Opción | Tipo | Descripción |
| - | - | - |
| `bearerToken` | `string` | Tu API key de Dodo Payments. |
| `environment` | `string` | `test_mode` o `live_mode`. El 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 body POST tiene prioridad. |
| `type` | `string` | El flujo de checkout: `static`, `dynamic` o `session`. El valor predeterminado es `static`. |

El controlador ofrece checkout estático para solicitudes `GET`. Para solicitudes `POST`, crea un enlace de pago dinámico cuando `type` es `dynamic` y una checkout session en los demás casos.

<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 ISO 3166-1 alpha-2.
    </ParamField>

    <ParamField query="addressLine" type="string">
      Dirección postal 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 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 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 postal.
    </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 es inferior al 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 por `metadata_` se pasa al checkout como metadata, por ejemplo `metadata_orderId=123`.
    </ParamField>

    Una flag de desactivación solo tiene efecto cuando el campo correspondiente tiene un valor, por ejemplo `email` con `disableEmail=true`. El controlador añade `returnUrl` de su configuración al enlace como `redirect_url`.

    <Warning>
      Si falta `productId`, el controlador devuelve una respuesta 400. Los parámetros de consulta no válidos o un producto que no exista en tu cuenta también devuelven 400.
    </Warning>

    ### Formato de respuesta

    El checkout estático devuelve una respuesta JSON con la URL de checkout. En test mode, la URL utiliza `test.checkout.dodopayments.com`:

    ```json theme={null}
    {
      "checkout_url": "https://test.checkout.dodopayments.com/buy/pdt_fqJhl7pxKWiLhwQR042rh?quantity=1&redirect_url=https%3A%2F%2Fyourdomain.com%2Fcheckout%2Fsuccess"
    }
    ```
  </Accordion>

  <Accordion title="Dynamic Checkout (POST)">
    * Envía los parámetros como un body JSON en una solicitud POST.
    * Admite pagos únicos y recurrentes. El controlador recupera el producto; después crea una suscripción si el producto es recurrente y un pago único en caso contrario.
    * El body necesita `billing` (con `street`, `city`, `state`, `country` e `zipcode`) e `customer`, además de `product_id` o `product_cart`. Las suscripciones necesitan `product_id`.
    * Para consultar todos los campos de body compatibles, visita:
      * [Body de la solicitud para un producto de pago único](https://docs.dodopayments.com/api-reference/payments/post-payments)
      * [Body de la 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 nuevas integraciones deben usar checkout sessions.
    </Warning>

    ### Formato de respuesta

    El checkout dinámico devuelve una respuesta JSON con el enlace de pago como URL de checkout:

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

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

    Cada `checkout_url` funciona una vez y caduca después de 24 horas, o después de 15 minutos cuando pasas `confirm: true`. Una session creada con `payment_method_id` no devuelve `checkout_url`, por lo que el controlador responde con 400.

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

    ### Formato de respuesta

    Checkout sessions devuelven una respuesta JSON con la URL de checkout:

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

## Customer Portal Route Handler

El route handler de Customer Portal crea una session de Customer Portal para el cliente que indiques y redirige el navegador a ella. `CustomerPortal` acepta las mismas opciones `bearerToken` e `environment` que `Checkout`.

<Warning>
  El controlador no comprueba quién lo llama. 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 inició sesión.
</Warning>

### Parámetros de consulta

<ParamField query="customer_id" type="string" required>
  El ID de cliente de la session 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>

El controlador devuelve 400 si falta `customer_id` y 500 si no se puede crear la session del portal.

## Webhook Route Handler

El route handler de webhook verifica cada solicitud con tu secreto de webhook, pasado como `webhookKey`, antes de ejecutar tu código:

* **Method:** Solo se admiten solicitudes POST. Los demás métodos devuelven 405.
* **Signature Verification:** Verifica los headers `webhook-id`, `webhook-timestamp` e `webhook-signature` con `webhookKey`, siguiendo la especificación Standard Webhooks. Devuelve 401 si la verificación falla.
* **Payload Validation:** Valida el payload con Zod. Devuelve 400 si el payload no es válido.
* **Error Handling:**
  * 401: Firma no válida
  * 400: Payload no válido
  * 500: Error interno durante la verificación
* **Event Routing:** Llama a `onPayload` para cada evento, después al controlador correspondiente al tipo de evento y devuelve 200.

El adaptor no captura los errores que se producen en tus controladores. Se propagan a Astro y la solicitud falla.

### Controladores de eventos de webhook compatibles

Todos los controladores son opcionales y async, y reciben 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 adaptor 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 Astro developer assistant. Your task is to guide a user through integrating the @dodopayments/astro adapter into their existing Astro project.

The @dodopayments/astro adapter provides route handlers for Dodo Payments' Checkout, Customer Portal, and Webhook functionalities, designed for Astro server endpoints in src/pages/api/.

First, install the necessary packages. Use the package manager appropriate for your project (npm, yarn, or bun) based on the presence of lock files (e.g., package-lock.json for npm, yarn.lock for yarn, bun.lockb for bun):

npm install @dodopayments/astro

The endpoints must render on demand. Make sure the project has an Astro server adapter, and export prerender = false from each endpoint file unless the project uses output: 'server'.

Here's how you should structure your response:

    Ask the user which functionalities they want to integrate.

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

    Checkout Route Handler (for handling product checkouts)

    Customer Portal Route Handler (for managing customer subscriptions/details)

    Webhook Route Handler (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 Route Handler is selected:

Purpose: This handler manages different types of checkout flows. All checkout types (static, dynamic, and sessions) return JSON responses with checkout URLs for programmatic handling.
File Creation: Create a new file at src/pages/api/checkout.ts in your Astro project.

Code Snippet:

// src/pages/api/checkout.ts
import { Checkout } from "@dodopayments/astro";

export const prerender = false;

export const GET = Checkout({
  bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
  returnUrl: import.meta.env.DODO_PAYMENTS_RETURN_URL,
  environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
  type: "static", // optional, defaults to 'static'
});

export const POST = Checkout({
  bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
  returnUrl: import.meta.env.DODO_PAYMENTS_RETURN_URL,
  environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
  type: "session", // for checkout sessions, or "dynamic" for dynamic checkout
});

A file can export only one POST handler. To serve both dynamic checkout and checkout sessions, create a second endpoint file.

Configuration & Usage:

    bearerToken: Your Dodo Payments API key. It's recommended to set this via the DODO_PAYMENTS_API_KEY environment variable.

    returnUrl: (Optional) The URL to redirect the user to after a successful checkout. A return_url in the POST body takes precedence.

    environment: (Optional) Set to "test_mode" for testing, or omit/set to "live_mode" for production.

    type: (Optional) Set to "static" for GET/static checkout, "dynamic" for POST/dynamic checkout, or "session" for POST/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)

    Returns: {"checkout_url": "https://test.checkout.dodopayments.com/buy/pdt_nZuwz45WAs64n3l07zpQR?quantity=1"}

Dynamic Checkout (POST) - Returns JSON with checkout_url: Parameters are sent as a JSON body. It requires billing and customer, plus product_id or product_cart. Supports both one-time and recurring payments. Returns: {"checkout_url": "https://test.checkout.dodopayments.com/cbq"}. 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://test.checkout.dodopayments.com/session/cks_Gi6KGJ2zFJo9rq9Ukifwa"}. 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 Route Handler is selected:

Purpose: This handler 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 src/pages/api/customer-portal.ts in your Astro project.

Code Snippet:

// src/pages/api/customer-portal.ts
import { CustomerPortal } from "@dodopayments/astro";

export const prerender = false;

export const GET = CustomerPortal({
  bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
  environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
});

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.

If Webhook Route Handler is selected:

Purpose: This handler 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 src/pages/api/webhook.ts in your Astro project.

Code Snippet:

// src/pages/api/webhook.ts
import { Webhooks } from "@dodopayments/astro";

export const prerender = false;

export const POST = Webhooks({
  webhookKey: import.meta.env.DODO_PAYMENTS_WEBHOOK_KEY,
  onPayload: async (payload) => {
    // handle the payload
  },
  // ... other event handlers for granular control
});

Handler Details:

    Method: Only POST requests are supported. Other methods return 405.

    Signature Verification: The handler verifies the webhook signature using the 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 event handler that matches the payload type.

Supported Webhook Event Handlers:

    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 adapter functions correctly, you will need to manually set up the following environment variables in your Astro project's deployment environment (e.g., Vercel, Netlify, AWS, etc.):

    DODO_PAYMENTS_API_KEY: Your Dodo Payments API Key (required for Checkout and Customer Portal).

    DODO_PAYMENTS_RETURN_URL: (Optional) The URL to redirect to after a successful checkout (for Checkout handler).

    DODO_PAYMENTS_WEBHOOK_KEY: Your Dodo Payments Webhook Secret (required for Webhook handler).

    DODO_PAYMENTS_ENVIRONMENT: test_mode or live_mode. The handlers default to live_mode.

Example .env file:

DODO_PAYMENTS_API_KEY=your-api-key
DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
DODO_PAYMENTS_ENVIRONMENT=test_mode
DODO_PAYMENTS_RETURN_URL=your-return-url

Usage in your code:

bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY
webhookKey: import.meta.env.DODO_PAYMENTS_WEBHOOK_KEY

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. You can also add comments to their PR or chat depending on the context

```


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