Get Blocked Customer

GET

blocklist

customers

{entry_id}

JavaScript

import DodoPayments from 'dodopayments';

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

const blockedCustomer = await client.blocklist.customers.retrieve('entry_id');

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
)
blocked_customer = client.blocklist.customers.retrieve(
    "entry_id",
)
print(blocked_customer.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"),
	)
	blockedCustomer, err := client.Blocklist.Customers.Get(context.TODO(), "entry_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", blockedCustomer.ID)
}

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.BlockedCustomer;
import com.dodopayments.api.models.blocklist.customers.CustomerRetrieveParams;

public final class Main {
    private Main() {}

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

        BlockedCustomer blockedCustomer = client.blocklist().customers().retrieve("entry_id");
    }
}

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.BlockedCustomer
import com.dodopayments.api.models.blocklist.customers.CustomerRetrieveParams

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

    val blockedCustomer: BlockedCustomer = client.blocklist().customers().retrieve("entry_id")
}

require "dodopayments"

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

blocked_customer = dodo_payments.blocklist.customers.retrieve("entry_id")

puts(blocked_customer)

<?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 {
  $blockedCustomer = $client->blocklist->customers->retrieve('entry_id');

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

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

DodoPaymentsClient client = new();

CustomerRetrieveParams parameters = new() { EntryID = "entry_id" };

var blockedCustomer = await client.Blocklist.Customers.Retrieve(parameters);

Console.WriteLine(blockedCustomer);

use dodopayments::Client;

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

{
  "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"
}

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.

Path Parameters

entry_id

string

required

Blocklist entry id

Response

created_at

string<date-time>

required

customer_email

string

required

customer_id

string

required

customer_name

string

required

string

required

identifier

string

required

Customer id or email that the merchant supplied.

source

enum<string>

required

Where a block came from. Api marks an API-key caller, which carries no dashboard actor. The other values name the screen the merchant used.

Available options:

blocklist_page,

customer_page,

payment_page,

dispute_page,

api

blocked_by_email

string | null

Dashboard user who blocked the customer. null for an API-key caller.

cancelled_subscription_ids

string[] | null

Subscriptions this block cancelled. Present on the create response only.

notes

object[] | null

Activity log. Present on the detail response only.

Show child attributes

reason

string | null

remaining_subscription_ids

string[] | null

Subscriptions this block left live, because the cancel failed or the inline batch filled up. Repeat the create call to continue; the block itself is already in force.

subscriptions_swept

boolean | null

False when the block left live subscriptions behind, including the case where the sweep could not list them and remaining_subscription_ids is therefore unknown. Repeat the create call until it reads true.

unblocked_at

string<date-time> | null

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
});

const blockedCustomer = await client.blocklist.customers.retrieve('entry_id');

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
)
blocked_customer = client.blocklist.customers.retrieve(
    "entry_id",
)
print(blocked_customer.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"),
	)
	blockedCustomer, err := client.Blocklist.Customers.Get(context.TODO(), "entry_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", blockedCustomer.ID)
}

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.BlockedCustomer;
import com.dodopayments.api.models.blocklist.customers.CustomerRetrieveParams;

public final class Main {
    private Main() {}

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

        BlockedCustomer blockedCustomer = client.blocklist().customers().retrieve("entry_id");
    }
}

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.BlockedCustomer
import com.dodopayments.api.models.blocklist.customers.CustomerRetrieveParams

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

    val blockedCustomer: BlockedCustomer = client.blocklist().customers().retrieve("entry_id")
}

require "dodopayments"

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

blocked_customer = dodo_payments.blocklist.customers.retrieve("entry_id")

puts(blocked_customer)

<?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 {
  $blockedCustomer = $client->blocklist->customers->retrieve('entry_id');

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

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

DodoPaymentsClient client = new();

CustomerRetrieveParams parameters = new() { EntryID = "entry_id" };

var blockedCustomer = await client.Blocklist.Customers.Retrieve(parameters);

Console.WriteLine(blockedCustomer);

use dodopayments::Client;

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

{
  "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"
}

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

Path Parameters

Response