customer.deleted

Sent when a customer is deleted.

Discord & Slack support: Basic

type

string

required

Allowed value: "customer.deleted"

Example:

"customer.deleted"

data

object

required

A customer in an organization.

data.id

string

required

The ID of the customer.

Example:

"992fae2a-2a17-4b7a-8d9e-e287cf90131b"

data.created_at

string

required

Creation timestamp of the object.

data.modified_at

string | null

required

Last modification timestamp of the object.

data.metadata

object

required

data.external_id

string | null

required

The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.

Example:

"usr_1337"

data.email

string

required

The email address of the customer. This must be unique within the organization.

Example:

"customer@example.com"

data.email_verified

boolean

required

Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.

Example:

true

data.name

string | null

required

The name of the customer.

Example:

"John Doe"

data.billing_address

object | null

required

data.tax_id

any[] | null

required

Example:

["911144442", "us_ein"]

data.organization_id

string

required

The ID of the organization owning the customer.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

data.avatar_url

string

required

Example:

"https://www.gravatar.com/avatar/xxx?d=blank"

Was this page helpful?

customer.updated

checkout.created

{
  "type": "customer.deleted",
  "data": {
    "id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "metadata": {},
    "external_id": "usr_1337",
    "email": "customer@example.com",
    "email_verified": true,
    "name": "John Doe",
    "billing_address": {
      "line1": "<string>",
      "line2": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US"
    },
    "tax_id": [
      "911144442",
      "us_ein"
    ],
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

customer.deleted