Dodo Payments Documentation

API Reference

How to Guides

Changelog

Dashboard

Community

Retrieve details of a specific license key instance by its ID.

Get License Key Instance

API KEY

Welcome to Dodo Payments documentation. This is a guide to help you understand and navigate the Dodo Payments dashboard

Introduction

In this section, we'll guide you through the initial steps to get started with our web application Before you dive into the specifics, make sure you meet the system requirements and have everything in place.

Quickstart

This document outlines the Onboarding Verification Process

Verification Process

This document provides detailed information about Dodo Payments’ fee structure for processing transactions, issuing payouts, and refunds and chargebacks. All fees outlined here will apply once a merchant’s account is live.

Pricing and Fee Structure

Learn the difference between Test Mode and Live Mode and how to switch between them.

Test Mode vs Live Mode

The list below includes the countries from which we accept payments for our SaaS and digital products.

Countries Eligible for Payment Acceptance

This documentation is designed to guide merchants through the completion of essential tax forms: Form W-9, Form W-8 BEN, and Form W-8 BEN-E.  These forms ensure compliance with tax regulations and help merchants claim appropriate tax benefits.


Tax Forms

Our Features

Learn how to create and manage your product catalog in the Admin Dashboard

Overview

The One-Time Payment Products feature in Dodo Payments allows merchants to offer digital products that customers purchase and pay for only once. Below is the step-by-step guide on how to add, edit, and delete one-time payment products in your product catalogue.

One-Time Payment Products

The Subscription Products feature in Dodo Payments allows merchants to offer products that are billed on a recurring basis, such as monthly memberships, SaaS (Software-as-a-Service) plans, or recurring deliveries. This feature provides flexibility in setting up pricing, billing cycles, and even free trials, making it ideal for businesses looking to offer ongoing services or products.

Subscription

The Payments section provides merchants with a detailed overview of all payment transactions. Merchants can track payment statuses, initiate refunds, and access payment details for each transaction.

Payments

The Refunds section allows merchants to manage and initiate refunds for transactions. Merchants can initiate full or partial refunds directly from the transaction details view, with built-in rules ensuring compliance and protecting against errors.

Refunds

The Disputes section is dedicated to managing customer disputes related to payments. Merchants can view and manage disputes from the Transactions page, including tracking the status of chargebacks and responding to disputes.

Disputes

The License Key Management feature is designed to help merchants secure their digital products and services by generating, managing, and tracking unique license keys. This feature ensures only authorized users access your products and provides merchants with full control over their license key usage and distribution. Ideal for SaaS businesses and digital product vendors, the tool also includes advanced tracking and revocation capabilities for enhanced security.

License Keys

The Invoice Generation feature in Dodo Payments simplifies the billing process by automatically creating and delivering invoices after every successful payment. Whether for one-time purchases or recurring subscription renewals, invoices are generated to document transactions with clear, professional records.

Invoice Generation

Learn how Dodo Payments handles payouts to your bank account.

Merchants on Dodo Payments are required to link a bank account to receive payouts. The information and fields required may vary based on the location of the bank account. This guide will outline the required fields and specifications for each region.

Link Bank Account

This document outlines the necessary information and documents required for Dodo Payments to process payouts. The requirements vary based on business registration status, type of business, and geographical location

Payout Compliance

The Payout process will be via Bank Transfer or Paypal transfer as per merchant preference

Payout Process

Webhooks provide a mechanism for real-time notifications when specific events occur within Dodo Payments, enabling seamless automation and integration with your application.

Webhooks

This section provides details on key analytics and reports for business analysis

Analytics and Reporting

The Customers Page in Dodo Payments allows merchants to manage their customer relationships by providing a detailed view of all customers who have made a purchase.

Customers

The Fraud Detection & Security feature in Dodo Payments helps merchants protect their business from fraudulent activities and secure customer transactions.

Fraud Detection & Security

This section allows you to generate API Keys through the Dashboard

API Key Generation

We value feedback from our merchants and aim to continuously improve Dodo Payments to meet your business needs. The **Feature Request and Roadmap** section allows you to directly contribute to our product development by suggesting new features, voting on existing requests, and staying informed about upcoming updates.

Feature Request and Roadmap

This section provides an overview of the login process and how to access your account.

Login

This section provides an overview of the Identity Verification process.

Identity Verification

This section provides an overview of the Business Verification process.

Business Verification

This section provides an overview of the process to add a one-time product to your Dodo Payments account.

Add One Time Payment Product

This section provides an overview of the process to add a subscription product to your Dodo Payments account.

Add Subscription Product

This section provides an overview of the process to refund a payment for your Dodo Payments account.

Payment links

Learn how to integrate Dodo Payments into your checkout process

Checkout Process

This section provides an overview of the process to view and manage payments for your Dodo Payments account.

This section provides an overview of the process to view and manage disputes for your Dodo Payments account.

This section provides an overview of the process to view and download reports for your Dodo Payments account.

Reports

This section provides an overview of the process to add a bank account to your Dodo Payments account.

Add Bank Account Information

This section provides an overview of the process to generate API keys for your Dodo Payments account.

API Keys generation

This section provides an overview of the process to create a webhook for your Dodo Payments account.

Webhook Creation

This section provides an overview of the process to view and manage your business profile for your Dodo Payments account.

Business Profile

This section provides an overview of the process to view and manage your user profile for your Dodo Payments account.

User Profile

We understand that navigating a new platform or resolving issues can sometimes require additional support. To ensure a seamless experience, we offer multiple support channels to address all your concerns.

Help and Support

Frequently Asked Questions about Dodo Payments

Merchant can access and manage their personal account information such as Contact Name, Profile Image and phone number for a more personalised experience through the my account section.

My Accounts

Welcome to the Dodo Payments Changelog! Stay updated on all the latest features and improvements we've rolled out to enhance your payment processing experience. At Dodo Payments, we strive to provide a seamless, transparent, and robust platform for global merchants.

Introducing Invoice API, subscription webhooks, comprehensive guides, Dodo Wall of Love, and social sharing features. Plus, enhanced subscription trial periods and customer identification.

v0.15.1 (4 Jan 2025)

Introduced the License Key Management feature, enhancing security and control for merchants distributing digital products and services.

v0.14.0 (26 Dec 2024)

Updated Atlas codebase, SDK updates, and minor improvements.

v0.13.2 (21 Dec 2024)

Added official SDKs, metadata field, and expanded customer APIs with minor improvements and bug fixes.

v0.12.0 (17 Dec 2024)

Introduced automated emails, webhook event logs, a license key generation guide, and various minor improvements and bug fixes.

v0.11.0 (13 Dec 2024)

Open-sourced Atlas demo, feature-request section, webhook request logs API, subscription list API, and various improvements and bug fixes.

v0.10.0 (8 Dec 2024)

This is the initial release of the Dodo Payments documentation, marking the Beta launch of our product. Explore the features and improvements designed to enhance your payment processing experience.

v0.1.0 (25 Nov 2024)

Welcome to the Dodo Payments API. Our APIs makes it easy to integrate secure, scalable, and versatile payment solutions into your applications.

Official SDKs of Node, Python & Go for integrating Dodo Payments

SDKs - Node, Python & Go

This guide will help you integrate the Dodo Payments API into your website.

API Integration Guide

This guide will help you integrate the Dodo Payments Subscription Product into your website.

Subscription Integration Guide

Understand the different webhook events triggered by Dodo Payments during payment, refund, subscription, dispute, and license key activities

Webhook Event Guide

Learn how to use metadata to store additional information about your Dodo Payments objects

Metadata Guide

Get a list of all payments associated with your account.

List Payments

Create a one-time payment for a customer.

Create One Time Payment

Get detailed information about a specific payment.

Get Payment Detail

Get Invoice

Get a list of all subscriptions associated with your account.

List subscriptions

Create Subscription

Get detailed information about a specific subscription.

Get Subscription Detail

Update Subscription

This endpoint allows you to activate a license for the user.

Activate License

This endpoint allows you to deactivate a license for the user.

Deactivate License

This endpoint allows you to validate a license for the user.

Validate License

Retrieve a list of license keys associated with your account.

Get License Keys

Retrieve the details of a specific license key by its ID.

Get License Key

This endpoint allows you to update a license key by its ID.

Update License Key

Retrieve a list of instances for a specific license key.

Get License Key Instances

This endpoint allows you to update a specific license key instance by its ID.

Update License Key Instance

Create a new customer in your Dodo Payments account.

Create Customer

Get a list of all customers associated with your account.

List Customers

Get detailed information about a specific customer.

Get Customer Detail

Patch Customer

Get a list of all webhook events associated with your account.

List Webhook Events

Get detailed information about a specific webhook event.

Get Webhook Event Detail

Send a POST request to your webhook URL to receive notifications about events that occur in your account.

Outgoing Webhooks

Get a list of all products associated with your account.

List Products

Create Product

Get detailed information about a specific product.

Get Product Detail

Update Product

Update Product Images

Get a list of all refunds associated with your account.

List Refunds

Create Refund

Get detailed information about a specific refund.

Get Refund Detail

Get a list of all disputes associated with your account.

List Disputes

Get detailed information about a specific dispute.

Get Dispute Detail

Get a list of all payouts associated with your account.

List Payouts

Retrieve a list of countries that are supported by the Dodo Payments for your customers.

API Documentation & SDKs

Payments

Subscriptions

Licenses

Customers

Webhooks

Products

Refunds

Disputes

Payouts

Miscellaneous

Get License Key Instance

Authorizations

Path Parameters

Response