Docs

customer.created

Occurs when a customer is created.

Occurs when a customer is created. Paddle creates customers automatically when someone provides their details at Paddle Checkout. You can also create customers using the API.

event_idstringrequired
Example: evt_01gks14ge726w50ch2tmaw2a1x
Unique Paddle ID for this event, prefixed with evt_.
Pattern: ^evt_[a-z\d]{26}$
event_typestringrequired
Type of event sent by Paddle, in the format entity.event_type.
Values
+ Show all values
occurred_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this event occurred.
notification_idstringrequired
Example: ntf_01ghbkd0frb9k95cnhwd1bxpvk
Unique Paddle ID for this notification, prefixed with ntf_.
Pattern: ^ntf_[a-z\d]{26}$
dataobjectrequired
New or changed entity.
idstringrequired
Example: ctm_01ghbm8g2qxsjp07p5ywsy61cs
Unique Paddle ID for this customer entity, prefixed with ctm_.
Pattern: ^ctm_[a-z\d]{26}$
namestring | nullrequired
Example: Dipen Lad
Full name.
Length: 1–1024
emailstring (email)required
Example: dipen.lad@paddle.com
Email address for this entity.
Length: 1–1024
marketing_consentbooleanrequired
Whether this customer opted into marketing from you. false unless customers check the marketing consent box when using Paddle Checkout. Set automatically by Paddle.
statusstringrequired
Whether this entity can be used in Paddle.
Values
  • active
    Entity is active and can be used.
  • archived
    Entity is archived, so can't be used.
custom_dataobject | nullrequired
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data.
localestringrequired
Default: en
A short form locale tag following the IETF BCP 47 standard.
import_metaobject | nullrequired
Import information for this entity. null if this entity is not imported.
external_idstring | null
Example: 9b95b0b8-e10f-441a-862e-1936a6d818ab
Reference or identifier for this entity from the provider where it was imported from.
Length: 1–200
imported_fromstringrequired
Example: paddle_classic
Name of the platform or provider where this entity was imported from.
Length: 1–200
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time) | nullrequired
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
customer.created
{
  "event_id": "evt_01hv6y1jtn1fr98zq3cvarxx2e",
  "event_type": "customer.created",
  "occurred_at": "2024-04-11T15:57:25.205966Z",
  "notification_id": "ntf_01hv6y1jx2m6n1qk95m0cj69dg",
  "data": {
    "id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
    "name": "Jo Brown",
    "email": "jo@example.com",
    "locale": "en",
    "status": "active",
    "created_at": "2024-04-11T15:57:24.813Z",
    "updated_at": "2024-04-11T15:57:24.813Z",
    "custom_data": null,
    "import_meta": null,
    "marketing_consent": false
  }
}

Was this page helpful?