Block Customer
Add a customer to your blocklist by customer ID or email address.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
- Option 1
- Option 2
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 to block. The block still applies to that customer's email.
Why the merchant blocked this customer. The entry page shows it.
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.
blocklist_page, customer_page, payment_page, dispute_page, api Response
Customer id or email that the merchant supplied.
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.
blocklist_page, customer_page, payment_page, dispute_page, api Dashboard user who blocked the customer. null for an API-key caller.
Subscriptions this block cancelled. Present on the create response only.
Activity log. Present on the detail response only.
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.
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.