List Blocked Customers

GET

blocklist

customers

JavaScript

import DodoPayments from 'dodopayments';

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

// Automatically fetches more pages as needed.
for await (const blockedCustomer of client.blocklist.customers.list()) {
  console.log(blockedCustomer.id);
}

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
page = client.blocklist.customers.list()
page = page.items[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	page, err := client.Blocklist.Customers.List(context.TODO(), dodopayments.BlocklistCustomerListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.blocklist.customers.CustomerListPage;
import com.dodopayments.api.models.blocklist.customers.CustomerListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        CustomerListPage page = client.blocklist().customers().list();
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.blocklist.customers.CustomerListPage
import com.dodopayments.api.models.blocklist.customers.CustomerListParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val page: CustomerListPage = client.blocklist().customers().list()
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

page = dodo_payments.blocklist.customers.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $page = $client->blocklist->customers->list(
    blockedByEmail: 'blocked_by_email',
    createdAtGte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    createdAtLte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    identifier: 'identifier',
    pageNumber: 0,
    pageSize: 0,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Blocklist.Customers;

DodoPaymentsClient client = new();

CustomerListParams parameters = new();

var page = await client.Blocklist.Customers.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .blocklist()
        .customers()
        .list()
        .query(serde_json::json!({}))
        .await?;
    println!("{result:?}");
    Ok(())
}

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "customer_email": "<string>",
      "customer_id": "<string>",
      "customer_name": "<string>",
      "id": "<string>",
      "identifier": "<string>",
      "source": "blocklist_page",
      "blocked_by_email": "<string>",
      "cancelled_subscription_ids": [
        "<string>"
      ],
      "notes": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "note": "<string>",
          "author_email": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "reason": "<string>",
      "remaining_subscription_ids": [
        "<string>"
      ],
      "subscriptions_swept": true,
      "unblocked_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Authorizations

Authorization

string

header

required

Send your API key as a bearer token: Authorization: Bearer <api_key>. A test mode key starts with dodo_test_, for example dodo_test_AbCd1234EfGh5678.<secret>. A live mode key starts with dodo_live_. Use a test mode key on test.dodopayments.com and a live mode key on live.dodopayments.com. Keys from before these tags have no tag and operate as before.

Query Parameters

identifier

string | null

Partial, case-insensitive match on the email and on the customer id.

blocked_by_email

string | null

Filter by the dashboard user who blocked the customer.

created_at_gte

string<date-time> | null

Blocked on or after this time.

created_at_lte

string<date-time> | null

Blocked on or before this time.

page_size

integer<int32> | null

Page size. Default 10, maximum 100.

Required range: x >= 0

page_number

integer<int32> | null

Page number. Default 0.

Required range: x >= 0

Response

items

object[]

required

Show child attributes

total

integer<int64>

required

Blocked customers that match the filters, before pagination.

Last modified on October 28, 2026

JavaScript

import DodoPayments from 'dodopayments';

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

// Automatically fetches more pages as needed.
for await (const blockedCustomer of client.blocklist.customers.list()) {
  console.log(blockedCustomer.id);
}

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
page = client.blocklist.customers.list()
page = page.items[0]
print(page.id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	page, err := client.Blocklist.Customers.List(context.TODO(), dodopayments.BlocklistCustomerListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.blocklist.customers.CustomerListPage;
import com.dodopayments.api.models.blocklist.customers.CustomerListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        CustomerListPage page = client.blocklist().customers().list();
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.blocklist.customers.CustomerListPage
import com.dodopayments.api.models.blocklist.customers.CustomerListParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val page: CustomerListPage = client.blocklist().customers().list()
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

page = dodo_payments.blocklist.customers.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $page = $client->blocklist->customers->list(
    blockedByEmail: 'blocked_by_email',
    createdAtGte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    createdAtLte: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    identifier: 'identifier',
    pageNumber: 0,
    pageSize: 0,
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Blocklist.Customers;

DodoPaymentsClient client = new();

CustomerListParams parameters = new();

var page = await client.Blocklist.Customers.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .blocklist()
        .customers()
        .list()
        .query(serde_json::json!({}))
        .await?;
    println!("{result:?}");
    Ok(())
}

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "customer_email": "<string>",
      "customer_id": "<string>",
      "customer_name": "<string>",
      "id": "<string>",
      "identifier": "<string>",
      "source": "blocklist_page",
      "blocked_by_email": "<string>",
      "cancelled_subscription_ids": [
        "<string>"
      ],
      "notes": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "note": "<string>",
          "author_email": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "reason": "<string>",
      "remaining_subscription_ids": [
        "<string>"
      ],
      "subscriptions_swept": true,
      "unblocked_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

API Reference

Checkout Sessions

Payments

Subscriptions

Invoices

Discounts

Licenses

Entitlements

Customers

Customer Wallets

Customer Blocklist

Products

Localized Pricing

Addons

Credit Entitlements

Meters

Usage Events

Refunds

Disputes

Payouts

Balance Ledger

Moderation

Brands

Webhooks

Miscellaneous

Product Collections

Authorizations

Query Parameters

Response