customer.state_changed

Sent when a customer state has changed.

It's triggered when:

Customer is created, updated or deleted.
A subscription is created or updated.
A benefit is granted or revoked.

Discord & Slack support: Basic

type

string

required

Allowed value: "customer.state_changed"

Example:

"customer.state_changed"

data

object

required

A customer along with additional state information:

Active subscriptions
Active benefits

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.deleted_at

string | null

required

Timestamp for when the customer was soft deleted.

data.active_subscriptions

object[]

required

The customer's active subscriptions.

An active customer subscription.

data.active_subscriptions.id

string

required

The ID of the subscription.

Example:

"e5149aae-e521-42b9-b24c-abb3d71eea2e"

data.active_subscriptions.created_at

string

required

Creation timestamp of the object.

data.active_subscriptions.modified_at

string | null

required

Last modification timestamp of the object.

data.active_subscriptions.metadata

object

required

data.active_subscriptions.status

string

required

Allowed value: "active"

Example:

"active"

data.active_subscriptions.amount

integer

required

The amount of the subscription.

Example:

1000

data.active_subscriptions.currency

string

required

The currency of the subscription.

Example:

"usd"

data.active_subscriptions.recurring_interval

enum<string>

required

The interval at which the subscription recurs.

Available options:

month,

year

data.active_subscriptions.current_period_start

string

required

The start timestamp of the current billing period.

Example:

"2025-02-03T13:37:00Z"

data.active_subscriptions.current_period_end

string | null

required

The end timestamp of the current billing period.

Example:

"2025-03-03T13:37:00Z"

data.active_subscriptions.cancel_at_period_end

boolean

required

Whether the subscription will be canceled at the end of the current period.

Example:

false

data.active_subscriptions.canceled_at

string | null

required

The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.

Example:

null

data.active_subscriptions.started_at

string | null

required

The timestamp when the subscription started.

Example:

"2025-01-03T13:37:00Z"

data.active_subscriptions.ends_at

string | null

required

The timestamp when the subscription will end.

Example:

null

data.active_subscriptions.product_id

string

required

The ID of the subscribed product.

Example:

"d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23"

data.active_subscriptions.discount_id

string | null

required

The ID of the applied discount, if any.

Example:

null

data.active_subscriptions.price_id

string

requireddeprecated

Example:

"196ca717-4d84-4d28-a1b8-777255797dbc"

data.active_subscriptions.custom_field_data

object

Key-value object storing custom field values.

data.granted_benefits

object[]

required

The customer's active benefit grants.

An active benefit grant for a customer.

data.avatar_url

string

required

Example:

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

Was this page helpful?

List Downloadables

customer.created

{
  "type": "customer.state_changed",
  "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",
    "deleted_at": "2023-11-07T05:31:56Z",
    "active_subscriptions": [
      {
        "id": "e5149aae-e521-42b9-b24c-abb3d71eea2e",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "custom_field_data": {},
        "metadata": {},
        "status": "active",
        "amount": 1000,
        "currency": "usd",
        "recurring_interval": "month",
        "current_period_start": "2025-02-03T13:37:00Z",
        "current_period_end": "2025-03-03T13:37:00Z",
        "cancel_at_period_end": false,
        "canceled_at": null,
        "started_at": "2025-01-03T13:37:00Z",
        "ends_at": null,
        "product_id": "d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23",
        "discount_id": null,
        "price_id": "196ca717-4d84-4d28-a1b8-777255797dbc"
      }
    ],
    "granted_benefits": [
      {
        "id": "d322132c-a9d0-4e0d-b8d3-d81ad021a3a9",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "granted_at": "2025-01-03T13:37:00Z",
        "benefit_id": "397a17aa-15cf-4cb4-9333-18040203cf98",
        "benefit_type": "custom",
        "properties": {
          "account_id": "<string>",
          "guild_id": "<string>",
          "role_id": "<string>"
        }
      }
    ],
    "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

customer.state_changed