Dodo Payments TypeScript API Library

This library provides convenient access to the Dodo Payments REST API from server-side TypeScript or JavaScript.

The REST API documentation can be found on docs.dodopayments.com. The full API of this library can be found in api.md.

It is generated with Stainless.

MCP Server

Use the Dodo Payments MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.

Note: You may need to set environment variables in your MCP client.

Installation

npm install dodopayments

Usage

The full API of this library can be found in api.md.

<!-- prettier-ignore -->

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
  environment: 'test_mode', // defaults to 'live_mode'
});

const checkoutSessionResponse = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'product_id', quantity: 0 }],
});

console.log(checkoutSessionResponse.session_id);

Request & Response types

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

<!-- prettier-ignore -->

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
  environment: 'test_mode', // defaults to 'live_mode'
});

const params: DodoPayments.CheckoutSessionCreateParams = {
  product_cart: [{ product_id: 'product_id', quantity: 0 }],
};
const checkoutSessionResponse: DodoPayments.CheckoutSessionResponse =
  await client.checkoutSessions.create(params);

Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.

Handling errors

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of APIError will be thrown:

<!-- prettier-ignore -->

const checkoutSessionResponse = await client.checkoutSessions
  .create({ product_cart: [{ product_id: 'product_id', quantity: 0 }] })
  .catch(async (err) => {
    if (err instanceof DodoPayments.APIError) {
      console.log(err.status); // 400
      console.log(err.name); // BadRequestError
      console.log(err.headers); // {server: 'nginx', ...}
    } else {
      throw err;
    }
  });

Error codes are as follows:

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default.

You can use the maxRetries option to configure or disable this:

<!-- prettier-ignore -->

// Configure the default for all requests:
const client = new DodoPayments({
  maxRetries: 0, // default is 2
});

// Or, configure per-request:
await client.checkoutSessions.create({ product_cart: [{ product_id: 'product_id', quantity: 0 }] }, {
  maxRetries: 5,
});

Timeouts

Requests time out after 1 minute by default. You can configure this with a timeout option:

<!-- prettier-ignore -->

// Configure the default for all requests:
const client = new DodoPayments({
  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});

// Override per-request:
await client.checkoutSessions.create({ product_cart: [{ product_id: 'product_id', quantity: 0 }] }, {
  timeout: 5 * 1000,
});

On timeout, an APIConnectionTimeoutError is thrown.

Note that requests which time out will be retried twice by default.

Auto-pagination

List methods in the DodoPayments API are paginated. You can use the for await … of syntax to iterate through items across all pages:

async function fetchAllPaymentListResponses(params) {
  const allPaymentListResponses = [];
  // Automatically fetches more pages as needed.
  for await (const paymentListResponse of client.payments.list()) {
    allPaymentListResponses.push(paymentListResponse);
  }
  return allPaymentListResponses;
}

Alternatively, you can request a single page at a time:

let page = await client.payments.list();
for (const paymentListResponse of page.items) {
  console.log(paymentListResponse);
}

// Convenience methods are provided for manually paginating:
while (page.hasNextPage()) {
  page = await page.getNextPage();
  // ...
}

Advanced Usage

Accessing raw Response data (e.g., headers)

The "raw" Response returned by fetch() can be accessed through the .asResponse() method on the APIPromise type that all methods return. This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.

You can also use the .withResponse() method to get the raw Response along with the parsed data. Unlike .asResponse() this method consumes the body, returning once it is parsed.

<!-- prettier-ignore -->

const client = new DodoPayments();

const response = await client.checkoutSessions
  .create({ product_cart: [{ product_id: 'product_id', quantity: 0 }] })
  .asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object

const { data: checkoutSessionResponse, response: raw } = await client.checkoutSessions
  .create({ product_cart: [{ product_id: 'product_id', quantity: 0 }] })
  .withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(checkoutSessionResponse.session_id);

Logging

[!IMPORTANT] All log messages are intended for debugging only. The format and content of log messages may change between releases.

Log levels

The log level can be configured in two ways:

1. Via the DODO_PAYMENTS_LOG environment variable
2. Using the logLevel client option (overrides the environment variable if set)

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  logLevel: 'debug', // Show all log messages
});

Available log levels, from most to least verbose:

• 'debug' - Show debug messages, info, warnings, and errors
• 'info' - Show info messages, warnings, and errors
• 'warn' - Show warnings and errors (default)
• 'error' - Show only errors
• 'off' - Disable all logging

At the 'debug' level, all HTTP requests and responses are logged, including headers and bodies. Some authentication-related headers are redacted, but sensitive data in request and response bodies may still be visible.

Custom logger

By default, this library logs to globalThis.console. You can also provide a custom logger. Most logging libraries are supported, including pino, winston, bunyan, consola, signale, and @std/log. If your logger doesn't work, please open an issue.

When providing a custom logger, the logLevel option still controls which messages are emitted, messages below the configured level will not be sent to your logger.

import DodoPayments from 'dodopayments';
import pino from 'pino';

con

---