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"

timestamp

string<date-time>

required

data

CustomerState · object

required

A customer along with additional state information:

Active subscriptions
Granted benefits
Active meters

Show child attributes

data.id

string<uuid4>

required

The ID of the customer.

data.created_at

string<date-time>

required

Creation timestamp of the object.

data.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

data.metadata

Metadata · object

required

Show child attributes

data.metadata.{key}

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.

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.

data.name

string | null

required

The name of the customer.

Example:

"John Doe"

data.billing_address

Address · object

required

Show child attributes

data.billing_address.country

enum<string>

required

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW

data.billing_address.line1

string | null

data.billing_address.line2

string | null

data.billing_address.postal_code

string | null

data.billing_address.city

string | null

data.billing_address.state

string | null

data.tax_id

any[] | null

required

Required array length: 2 elements

Example:

["911144442", "us_ein"]

data.organization_id

string<uuid4>

required

The ID of the organization owning the customer.

data.deleted_at

string<date-time> | null

required

Timestamp for when the customer was soft deleted.

data.active_subscriptions

CustomerStateSubscription · object[]

required

The customer's active subscriptions.

Show child attributes

data.active_subscriptions.id

string<uuid4>

required

The ID of the subscription.

data.active_subscriptions.created_at

string<date-time>

required

Creation timestamp of the object.

data.active_subscriptions.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

data.active_subscriptions.metadata

Metadata · object

required

Show child attributes

data.active_subscriptions.metadata.{key}

data.active_subscriptions.status

enum<string>

required

Available options:

active,

trialing

data.active_subscriptions.amount

integer

required

The amount of the subscription.

data.active_subscriptions.currency

string

required

The currency of the subscription.

data.active_subscriptions.recurring_interval

enum<string>

required

The interval at which the subscription recurs.

Available options:

day,

week,

month,

year

data.active_subscriptions.current_period_start

string<date-time>

required

The start timestamp of the current billing period.

data.active_subscriptions.current_period_end

string<date-time> | null

required

The end timestamp of the current billing period.

Example:

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

data.active_subscriptions.trial_start

string<date-time> | null

required

The start timestamp of the trial period, if any.

Example:

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

data.active_subscriptions.trial_end

string<date-time> | null

required

The end timestamp of the trial period, if any.

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.

data.active_subscriptions.canceled_at

string<date-time> | 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<date-time> | null

required

The timestamp when the subscription started.

Example:

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

data.active_subscriptions.ends_at

string<date-time> | null

required

The timestamp when the subscription will end.

Example:

null

data.active_subscriptions.product_id

string<uuid4>

required

The ID of the subscribed product.

data.active_subscriptions.discount_id

string<uuid4> | null

required

The ID of the applied discount, if any.

Example:

null

data.active_subscriptions.meters

CustomerStateSubscriptionMeter · object[]

required

List of meters associated with the subscription.

Show child attributes

data.active_subscriptions.meters.created_at

string<date-time>

required

Creation timestamp of the object.

data.active_subscriptions.meters.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

data.active_subscriptions.meters.id

string<uuid4>

required

The ID of the object.

data.active_subscriptions.meters.consumed_units

number

required

The number of consumed units so far in this billing period.

data.active_subscriptions.meters.credited_units

integer

required

The number of credited units so far in this billing period.

data.active_subscriptions.meters.amount

integer

required

The amount due in cents so far in this billing period.

data.active_subscriptions.meters.meter_id

string<uuid4>

required

The ID of the meter.

data.active_subscriptions.custom_field_data

Custom Field Data · object

Key-value object storing custom field values.

Show child attributes

data.active_subscriptions.custom_field_data.{key}

data.granted_benefits

CustomerStateBenefitGrant · object[]

required

The customer's active benefit grants.

Show child attributes

data.granted_benefits.id

string<uuid4>

required

The ID of the grant.

data.granted_benefits.created_at

string<date-time>

required

Creation timestamp of the object.

data.granted_benefits.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

data.granted_benefits.granted_at

string<date-time>

required

The timestamp when the benefit was granted.

data.granted_benefits.benefit_id

string<uuid4>

required

The ID of the benefit concerned by this grant.

data.granted_benefits.benefit_type

enum<string>

required

The type of the benefit concerned by this grant.

Available options:

custom,

discord,

github_repository,

downloadables,

license_keys,

meter_credit

data.granted_benefits.benefit_metadata

Benefit Metadata · object

required

The metadata of the benefit concerned by this grant.

Show child attributes

data.granted_benefits.benefit_metadata.{key}

data.granted_benefits.properties

BenefitGrantDiscordProperties · object

required

BenefitGrantDiscordProperties
BenefitGrantGitHubRepositoryProperties
BenefitGrantDownloadablesProperties
BenefitGrantLicenseKeysProperties
BenefitGrantCustomProperties

Show child attributes

data.granted_benefits.properties.account_id

string | null

data.granted_benefits.properties.guild_id

string

data.granted_benefits.properties.role_id

string

data.granted_benefits.properties.granted_account_id

string

data.active_meters

CustomerStateMeter · object[]

required

The customer's active meters.

Show child attributes

data.active_meters.id

string<uuid4>

required

The ID of the object.

data.active_meters.created_at

string<date-time>

required

Creation timestamp of the object.

data.active_meters.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

data.active_meters.meter_id

string<uuid4>

required

The ID of the meter.

data.active_meters.consumed_units

number

required

The number of consumed units.

data.active_meters.credited_units

integer

required

The number of credited units.

data.active_meters.balance

number

required

The balance of the meter, i.e. the difference between credited and consumed units.

data.avatar_url

string

required

General

Core API

Customer Portal API

Webhook Events

Integrations

customer.state_changed