POpolar
customers
public

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/v1/customers/{id}

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customers/{id}
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: customers:write)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

idstring uuid4 required

The customer ID.

Query parameters

anonymizeboolean

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.

Changes

No recorded changes to this operation across all 11 revisions of this API.