Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Which customer to block. Untagged, so the caller sends customer_id or email at the top level, as CustomerRequest does on the payment routes. A body that carries both matches the first variant, so customer_id wins.

customer_id
string
required

Customer to block. The block still applies to that customer's email.

reason
string | null

Why the merchant blocked this customer. The entry page shows it.

source
null | enum<string>

Screen the merchant blocked from. Ignored for an API-key caller, whose entry always records api. A dashboard caller that omits it records blocklist_page.

Available options:
blocklist_page,
customer_page,
payment_page,
dispute_page,
api

Response

created_at
string<date-time>
required
customer_email
string
required
customer_id
string
required
customer_name
string
required
id
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.

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