Delete customer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Description

Use this endpoint to delete an existing customer, which will return an empty response on success.

❗️

Deleting a customer also immediately cancels any active subscriptions on the customer. This operation cannot be undone.


What exactly happens?

When you call this endpoint:

  • The customer record is soft deleted.
  • Related entities are also soft deleted, including:
    • Subscriptions associated with the customer
    • Memberships associated with the customer
    • Payment sources
    • Addresses tied to the customer
    • Social network links (e.g., Google ID, Facebook ID, or other external identities)
  • All active subscriptions for this customer are automatically cancelled.

Automatic Personal Data Deletion

If Automatic Personal Data Deletion is enabled in the Pelcro platform
(Settings → Site Settings → Automatic Personal Data Deletion),
then after a customer is deleted through this API, Pelcro automatically removes or anonymizes personal data associated with that customer.

This ensures that personal information can no longer be linked to the deleted user, in alignment with international privacy regulations (e.g., GDPR).


Data Deletion & Redaction Behavior

The following outlines how customer data is handled when automatic personal data deletion is enabled, specifying which fields are cleared (deleted or nullified) versus redacted (scrambled, masked, or pseudonymized).


Customer Object

  • Salutation: nullified
  • First name: scrambled / masked (redacted)
  • Last name: scrambled / masked (redacted)
  • Display name: scrambled / masked (redacted)
  • Profile photo: deleted (platform and infrastructure storage)
  • Email: scrambled / masked (redacted)
  • Organization: nullified
  • Login last success IP: nullified
  • Login last failure IP: nullified
  • TIN: nullified
  • SDK register IP: nullified
  • Metadata: values scrambled / masked (redacted)

Address Object(s)

  • Salutation: nullified
  • First name: scrambled / masked (redacted)
  • Last name: scrambled / masked (redacted)
  • Title: nullified
  • Company: scrambled / masked (redacted)
  • Department: scrambled / masked (redacted)
  • Address lines (line1, line2): scrambled / masked (redacted)
  • Postal code: nullified
  • Phone: scrambled / masked (redacted)

Subscription Object(s)

  • Gift recipient email: scrambled / masked (redacted)
  • Gift recipient first name: scrambled / masked (redacted)
  • Gift recipient last name: scrambled / masked (redacted)

Payment Methods

  • Card-related properties (card ID, last 4 digits, expiry date, token): scrambled / masked (redacted)

Exports (Data, Accounting, Analytics)

All identifiable attributes listed above are pseudonymized in exports.


Activity Logs

  • All activity log entries related to the customer (including associated addresses, subscriptions, invoices, and orders) are deleted.
  • The customer.deleted activity log event is retained, but all identifiable details are masked/redacted.

Relationships & Related Records

The following relationships are soft deleted:

  • Social network user relationships
  • Subscriptions
  • Memberships
  • Invoices
  • Addresses
  • Payment methods

Learn more

See Automatic Personal Data Deletion for additional details about this feature.


Path Params
int32
required
Query Params
int32
required
Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json