Customers

Delete Customer

Delete a customer.

This action cannot be undone and will immediately:

Cancel any active subscriptions for the customer
Revoke all their benefits
Clear any external_id

Use it only in the context of deleting a user within your own service. Otherwise, use more granular API endpoints to cancel a specific subscription or revoke certain benefits.

Note: The customers information will nonetheless be retained for historic orders and subscriptions.

Set anonymize=true to also anonymize PII for GDPR compliance.

Scopes: customers:write

DELETE

customers

{id}

Python (SDK)

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    polar.customers.delete(id="<value>", anonymize=False)

    # Use the SDK ...

{
  "error": "<string>",
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

string<uuid4>

required

The customer ID.

Query Parameters

anonymize

boolean

default:false

If true, also anonymize the customer's personal data for GDPR compliance. This replaces email with a hashed version, hashes name and billing name (name preserved for businesses with tax_id), clears billing address, and removes OAuth account data.

Response

Customer deleted.

Get Customer by External IDGet a customer by external ID. **Scopes**: `customers:read` `customers:write`

⌘I

Python (SDK)

from polar_sdk import Polar


with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    polar.customers.delete(id="<value>", anonymize=False)

    # Use the SDK ...

{
  "error": "<string>",
  "detail": "<string>"
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Delete Customer

Authorizations

Path Parameters

Query Parameters

Response