Docs

business.created

Occurs when a business is created.

Occurs when a business is created. Paddle creates a business automatically when a customer provides their business details at Paddle Checkout. You can also create businesses 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: biz_01ghbmaszjgjd47g5f3d9vw7hg
Unique Paddle ID for this business entity, prefixed with biz_.
Pattern: ^biz_[a-z\d]{26}$
customer_idstringrequired
Example: ctm_01ghbm8g2qxsjp07p5ywsy61cs
The ID of the customer this business belongs to.
Pattern: ^ctm_[a-z\d]{26}$
namestringrequired
Example: Paddle.com Market Limited
Full name.
Length: 1–1024
company_numberstring | nullrequired
Example: 08172165
Company number for this business.
Length: 1–1024
tax_identifierstring | nullrequired
Example: ABC0123456789
Tax or VAT Number for this business.
Length: 1–1024
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.
contactsarrayrequired
namestringrequired
Full name of this contact.
Max length: 1024
emailstring (email)required
Example: test@paddle.com
Email address for this contact.
Length: 1–320
custom_dataobject | nullrequired
Example: {"customer_reference_id":"abcd1234"}
Your own structured key-value data.
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)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
business.created
{
  "event_id": "evt_01hv8hkrsnhgn77dk3443p62je",
  "event_type": "business.created",
  "occurred_at": "2024-04-12T06:58:38.517522Z",
  "notification_id": "ntf_01hv8hkrvm7grqzht4jbq8neyz",
  "data": {
    "id": "biz_01hv8hkr641vmpwytx38znv56k",
    "name": "Uplift Inc.",
    "status": "active",
    "contacts": [
      {
        "name": "Parker Jones",
        "email": "parker@example.com"
      }
    ],
    "created_at": "2024-04-12T06:58:37.892Z",
    "updated_at": "2024-04-12T06:58:37.892Z",
    "custom_data": null,
    "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
    "import_meta": null,
    "company_number": "555775291485",
    "tax_identifier": "555952383"
  }
}

Was this page helpful?